Markdown versions of all docs pages are available by appending .md to any docs URL.
Shortcodes
Every shortcode this module adds, grouped by what it does.
Every shortcode docs-theme-extras adds on top of Hextra, grouped by what it does. Each page is generated from the comment header of its source file, so the parameter tables cannot drift from the template that reads them.
UI components
Render a visual component on the page.
| Shortcode | Summary |
|---|---|
alert | Alias for callout, accepting the legacy context parameter name |
callout | Renders an admonition box whose icon is derived from its type |
card | Renders a styled card link with an optional icon or image, title and subtitle |
cards | Wraps inner card shortcodes in a responsive grid |
checklist | Renders its body as a checklist whose ticks persist in the browser |
details | Renders a collapsible details and summary block, closed by default |
gloss | Renders an inline glossary term with a tooltip carrying its definition |
render | Embeds the interactive changelog browser on a page |
table | Wraps a markdown table so the author picks how its columns size |
Gating
Decide whether content appears at all.
| Shortcode | Summary |
|---|---|
conditional-text | Includes or excludes its body based on the page’s build condition |
downstream | Drops its body in the upstream build and keeps it downstream |
upstream | Keeps its body in the upstream build and drops it downstream |
version | Renders its body only on the versions the author names |
Reuse and versioning
Pull in shared content, or vary it by version.
| Shortcode | Summary |
|---|---|
rebase | Renders a page from another version’s asset tree, rewriting its shortcodes to match |
reuse | Inlines a shared Markdown file from assets, resolving a version-specific copy first |
reuse-append | Concatenates a shared snippet with the inner content and renders them as one block |
reuse-image | Renders a shared image, optionally with a separate dark-mode variant |
reuse-image-dark | Renders an image in dark mode only, hidden entirely in light mode |
reuse-image-light | Renders an image in light mode only, hidden entirely in dark mode |
version-cards | Renders a card grid mirroring the navbar version dropdown |
External content
Pull content from outside the page’s own source.
| Shortcode | Summary |
|---|---|
github | Fetches a remote file by URL and inlines its contents |
github-table | Fetches a remote Markdown file and inlines one section of it by heading |
github-yaml | Fetches a remote YAML file and renders it as a captioned code block |
openapi | Embeds a Swagger UI viewer for an OpenAPI spec |
readfile | Inlines a file from the filesystem into the page |
Links
Resolve or emit a URL.
| Shortcode | Summary |
|---|---|
link | Alias for link-hextra, kept so existing call sites keep working |
link-hextra | Resolves a docs-relative path into a version- and product-aware URL |
redirect | Emits a client-side redirect from a stub page to its canonical location |
Deprecated
Superseded, kept for existing content.
| Shortcode | Summary |
|---|---|
prism | Deprecated compatibility stub for the lotus prism shortcode; use a fenced code block |
alert
Alias for callout, accepting the legacy context parameter name
callout
Renders an admonition box whose icon is derived from its type
card
Renders a styled card link with an optional icon or image, title and subtitle
cards
Wraps inner card shortcodes in a responsive grid
checklist
Renders its body as a checklist whose ticks persist in the browser
details
Renders a collapsible details and summary block, closed by default
gloss
Renders an inline glossary term with a tooltip carrying its definition
render
Embeds the interactive changelog browser on a page
table
Wraps a markdown table so the author picks how its columns size
conditional-text
Includes or excludes its body based on the page’s build condition
downstream
Drops its body in the upstream build and keeps it downstream
upstream
Keeps its body in the upstream build and drops it downstream
version
Renders its body only on the versions the author names
rebase
Renders a page from another version’s asset tree, rewriting its shortcodes to match
reuse
Inlines a shared Markdown file from assets, resolving a version-specific copy first
reuse-append
Concatenates a shared snippet with the inner content and renders them as one block
reuse-image
Renders a shared image, optionally with a separate dark-mode variant
reuse-image-dark
Renders an image in dark mode only, hidden entirely in light mode
reuse-image-light
Renders an image in light mode only, hidden entirely in dark mode
version-cards
Renders a card grid mirroring the navbar version dropdown
github
Fetches a remote file by URL and inlines its contents
github-table
Fetches a remote Markdown file and inlines one section of it by heading
github-yaml
Fetches a remote YAML file and renders it as a captioned code block
openapi
Embeds a Swagger UI viewer for an OpenAPI spec
readfile
Inlines a file from the filesystem into the page
link
Alias for link-hextra, kept so existing call sites keep working
link-hextra
Resolves a docs-relative path into a version- and product-aware URL
redirect
Emits a client-side redirect from a stub page to its canonical location
prism
Deprecated compatibility stub for the lotus prism shortcode; use a fenced code block