Markdown versions of all docs pages are available by appending .md to any docs URL.
Authoring
The shortcodes and render behavior this module adds on top of, or changes from, stock Hugo and Hextra.
This section covers what changes for a content author when a site imports
docs-theme-extras. For anything not listed here, the Hugo and Hextra defaults
apply unchanged.
Bookmark the upstream references. When something behaves the way you expect, it is probably stock Hugo or Hextra, and their docs are the right place to look first.
- Hugo, using shortcodes
- Hugo, built-in shortcodes
- Hugo, markup render hooks
- Hugo, the
RenderStringmethod, which is why call form matters - Hextra, shortcodes guide
Call form: percent versus angle brackets
Why this module’s shortcodes accept either call form interchangeably, when that stops being true, …
Shortcodes
Every shortcode this module adds, grouped by what it does.
Render hooks
How this module changes the way ordinary Markdown renders, without you calling anything.
Resolving links
The link and link-hextra contract: what they resolve, and the calls that fail silently.
Gating content
Choosing between upstream, downstream, conditional-text and version when the same source has to …