Shortcodes

The theme ships with 50+ shortcodes organized into six categories. Each page below renders the live result alongside the markdown that produced it.

Argument conventions #

Across the theme, shortcodes follow these rules:

• The primary argument is positional. For most shortcodes the first positional arg is the title, label, or href/src:

  markdown Copy

  {{< notice tip "Pro move" >}} ... {{< /notice >}}
  {{< card "Get started" "/install/" >}} ... {{< /card >}}
  {{< image "screenshot.png" "A dashboard caption" >}}

• Secondary arguments are named. Anything beyond the first one or two args should be named for clarity:

  markdown Copy

  {{< button href="/install/" icon="download" style="primary" >}}Install{{< /button >}}
  {{< step title="Deploy" time="5 min" n="3" >}}body{{< /step >}}

• Links use href. url is accepted as a legacy alias on card and a few others for relearn compatibility but should not be used in new content. The theme’s site-href.html partial routes every href through Hugo’s URL resolver, so internal paths like /docs/foo/ automatically pick up the site baseURL prefix and external http* URLs are passed through with target="_blank".

• Most block bodies are markdown. Container shortcodes such as notice, exercise, step, solution, tabs, card, and terminal render their body through Hugo’s markdown pipeline, so links, lists, code blocks, and nested shortcodes work where those blocks are intended to hold prose. Small inline/status shortcodes such as badge, kbd, time, and textcolor are intentionally more limited; check the shortcode’s reference entry before relying on markdown inside compact inline UI.

• Internationalization. Default labels (Tip, Note, Show solution, Quick check, etc.) are pulled from i18n/en.yaml. Translate the theme by adding i18n/<lang>.yaml to your own site — every default label and UI string is keyed there.