Content Formatting Examples

The Layer5 Academy platform supports a wide range of shortcodes for enriching your learning content. Shortcodes are reusable template snippets you invoke in Markdown files to generate HTML output. They come from four sources:

1. Academy Theme — custom shortcodes built specifically for the Academy platform.
2. Hextra — shortcodes ported from the Hextra Hugo theme, namespaced under hextra/ to avoid conflicts.
3. Docsy Theme — shortcodes inherited from the Google Docsy documentation theme.
4. Hugo Built-in — shortcodes included with the Hugo static site generator.

For guidance on creating your own shortcodes, see Extending the Academy.

Browse by category 🔗

Each example lives in its own page so you can inspect and reuse it independently. Use the sidebar or the links below to navigate.

Markdown 🔗

Standard Markdown formatting: text styles, code blocks, lists, tables, images, and footnotes.

Hugo Built-in Shortcodes 🔗

Shortcodes included with Hugo: figure, highlight, ref, relref, param, qr, details, and embedded media (youtube, vimeo, instagram, x).

Docsy Shortcodes 🔗

Shortcodes from the Google Docsy theme: alerts, page info, blocks (cover, lead, section, feature), cards, tabs, comments, conditional text, iframe, imgproc, readfile, and API docs (Redoc, SwaggerUI).

Hextra Shortcodes 🔗

Shortcodes ported from the Hextra theme: callouts, cards, details, steps, tabs, file tree, badges, icons, PDF embed, page include, glossary terms, Jupyter notebooks, and asciinema recordings.

Academy Theme Shortcodes 🔗

Custom shortcodes for the Academy platform: alerts, details, pageinfo, chapterstyle, image, SVG, local video, version labels, CSV tables, Meshery design embeds, and usestatic path resolution.