Skip to content

Add shortcodes reference for Academy content creators#924

Merged
fitzergerald merged 2 commits intomasterfrom
docs/shortcodes-reference
Mar 31, 2026
Merged

Add shortcodes reference for Academy content creators#924
fitzergerald merged 2 commits intomasterfrom
docs/shortcodes-reference

Conversation

@leecalcote
Copy link
Copy Markdown
Member

Summary

  • Adds a new Shortcodes Reference page under Cloud > Academy > Content Creator Guide
  • Documents all 34 shortcodes available to Academy content creators, organized by source:
    • Academy Theme (13): alert, chapterstyle, csvtable, csvtable-roles, details, image, lab-intro, local-video, meshery-design-embed, pageinfo, svg, usestatic (deprecated), version
    • Docsy Theme (14): tabpane/tab, card/cardpane, readfile, imgproc, iframe, swaggerui, redoc, comment, conditional-text, blocks/section, blocks/lead, blocks/cover, blocks/feature, blocks/link-down
    • Hugo Built-in (7): figure, gist, highlight, param, ref/relref, youtube, vimeo
  • Each shortcode entry includes parameters, defaults, and usage examples
  • Complements the existing Extending the Academy page which covers custom shortcode creation

Test plan

  • Verify the page renders correctly on the Netlify deploy preview
  • Confirm shortcode examples display properly (especially the live alert example)
  • Check that all links to external documentation (Docsy, Hugo) are valid

Document the definitive list of all supported shortcodes available in the
Academy platform, organized by source: Academy theme (13 shortcodes),
Docsy theme (14 shortcodes), and Hugo built-in (7 shortcodes). Each
entry includes parameters, defaults, and usage examples.

Signed-off-by: Lee Calcote <lee.calcote@layer5.io>
@netlify
Copy link
Copy Markdown

netlify bot commented Mar 31, 2026

Deploy Preview for bejewelled-pegasus-b0ce81 ready!

Name Link
🔨 Latest commit 2c7d7fa
🔍 Latest deploy log https://app.netlify.com/projects/bejewelled-pegasus-b0ce81/deploys/69cc28c7ffb07200085d08dc
😎 Deploy Preview https://deploy-preview-924--bejewelled-pegasus-b0ce81.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@fitzergerald fitzergerald merged commit f58284b into master Mar 31, 2026
7 checks passed
@fitzergerald fitzergerald deleted the docs/shortcodes-reference branch March 31, 2026 20:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants