Shortcodes

Shortcodes

This is the human-readable shortcode reference for authors and agents. The machine-readable source of truth is shortcodes.manifest.json, which distinguishes render variants from auxiliary support files.

Internal generator documentation helpers also exist:

• docs-source
• docs-json

Those are for rendering the generator’s own documentation website, not for normal site authoring.

Recommended Structured Content

These are available as shortcodes, but fenced blocks are usually better for editable website content because they round-trip cleanly through the page editor.

team

• purpose: staff / committee / management cards
• preferred authoring: fenced team YAML block
• shortcode params:
  • class
• inner data:
  • list or map with members / items / cards
• member fields:
  • name, role, image / src / photo, alt, bio, href / url / link, link_label, class, loading

gallery

• purpose: brochure/gallery image grids
• preferred authoring: fenced gallery YAML block
• shortcode params:
  • class
• inner data:
  • list or map with items / images / figures
• item fields:
  • image / src / photo, alt, caption / text / body, class, loading

contact

• purpose: contact card grids
• preferred authoring: fenced contact YAML block
• shortcode params:
  • class
• inner data:
  • list or map with items / cards / contacts
• item fields:
  • type, title, name, role, image, alt, body, href, link_label, class, loading

stats

• purpose: metrics / numeric highlight cards
• preferred authoring: fenced stats YAML block
• shortcode params:
  • class
• inner data:
  • list or map with items / stats / metrics

testimonials

• purpose: quote/testimonial grids
• preferred authoring: fenced testimonials YAML block
• shortcode params:
  • class
• inner data:
  • list or map with items / quotes / testimonials

faq

• purpose: question/answer blocks
• preferred authoring: fenced faq YAML block
• shortcode params:
  • class
• inner data:
  • list or map with items / faqs / questions

booking

• purpose: reservation widget backed by the shared booking API
• preferred authoring: fenced booking YAML block
• shortcode params:
  • title
  • class
• inner data:
  • map with title, intro, provider, view, booking/payment links, and items / resources / rooms
• item fields:
  • owner, name / title, description, price_lookup_key, class

calendar

• purpose: public what’s-on calendar backed by the shared booking API
• preferred authoring: fenced calendar YAML block
• shortcode params:
  • title
  • class
• inner data:
  • map with title, intro, view, booking_url, booking_label, and owners / items / resources / rooms
• item fields:
  • owner, name / title, description, class

fundalumin

• purpose: Fundalumin campaign discovery widget backed by the shared funding app
• preferred authoring: fenced fundalumin YAML block
• shortcode params:
  • title
  • class
• inner data:
  • map with title, intro, app_base_url, shared CTA links, and campaigns / items / profiles
• item fields:
  • slug, label, description, url, cta_label, class

Media And Embeds

embed

• purpose: iframe / external media / HTML / PDF / video embed wrapper
• shortcode params:
  • src or url
  • title
  • layout
  • class
  • caption
  • width
  • type
  • height
  • aspect
  • allow
  • allowfullscreen
  • sandbox
  • referrerpolicy
  • loading
  • iframeId
  • id
• inner text:
  • optional caption if caption is not set

icon

• purpose: render a named inline icon
• params:
  • first positional param = icon name

include

• purpose: inline a raw file into output
• params:
  • file
• note:
  • powerful but easy to misuse; not usually the best website-editing path for agents

Widgets

skill-meter

• purpose: render the shared training/skill widget
• params:
  • widget
  • user
  • variant
  • title
  • eyebrow
  • subtext
  • class

quiz

• purpose: render a shared quiz widget
• params:
  • src
  • class
  • id
  • title
• inner text:
  • optional inline YAML/JSON model when src is omitted

pydoc

• purpose: render Python API documentation from a source file
• params:
  • src
  • class

purchasemembership

• purpose: commerce/checkout widget
• status: legacy / site-specific
• note:
  • available in the theme, but not a recommended default for normal content authoring

Citation And Reference Helpers

cite

• purpose: citation rendering helper

bibliography

• purpose: print bibliography
• bibliography grouping is controlled by params.bibliography.groupBy
• supported grouping modes:
  • type: normalized type buckets such as journal articles, books, theses
  • manual: % bibgroup: key | Title markers in the source .bib
  • theme: JSON-backed thematic grouping from bibliography entries carrying theme / themes
  • none: flat ungrouped list
• theme grouping can be ordered and titled through params.bibliography.themeFile
  • preferred source is a site data file such as data/bibliography-themes.json
  • expected shape:
    • top-level groups array with key and title
    • top-level entries map keyed by citekey, merged into bib.json by the site pipeline

bibentry

• purpose: print a single bibliography entry

references

• purpose: print references list

ref

• purpose: link equation/figure references by label
• usage shape:
  • positional labels, including semicolon-separated groups

mref

• purpose: link to a documented class method anchor
• params:
  • class
  • method