Shortcodes Manifest
The canonical shortcode inventory rendered for the documentation website.
{
"notes": [
"This is the canonical shortcode inventory for agents and MCP integrations editing Quantalumin-backed websites.",
"Prefer fenced structured blocks over shortcode syntax for editable brochure content when both are supported."
],
"shortcodes": [
{
"category": "citation",
"inner_mode": "none",
"name": "bibentry",
"params": [
{
"kind": "positional",
"name": "0",
"required": true
}
],
"purpose": "Render a single bibliography entry.",
"recommended_for_agents": true,
"render_variants": [
"html"
],
"status": "supported"
},
{
"category": "citation",
"inner_mode": "none",
"name": "bibliography",
"params": [],
"purpose": "Render the bibliography list.",
"recommended_for_agents": true,
"render_variants": [
"html"
],
"status": "supported"
},
{
"category": "widget",
"editor_support": "structured-block-editor",
"inner_mode": "yaml_map",
"name": "booking",
"params": [
{
"name": "title",
"required": false
},
{
"name": "class",
"required": false
}
],
"preferred_authoring": "fenced_block",
"purpose": "Render a booking/reservation widget backed by the shared booking API.",
"recommended_for_agents": true,
"render_variants": [
"html",
"tex"
],
"status": "recommended",
"top_level_keys": [
"title",
"intro",
"description",
"provider",
"view",
"api_base_url",
"success_url",
"cancel_url",
"charges_url",
"terms_url",
"privacy_url",
"items",
"resources",
"rooms"
]
},
{
"category": "widget",
"editor_support": "structured-block-editor",
"inner_mode": "yaml_map",
"name": "calendar",
"params": [
{
"name": "title",
"required": false
},
{
"name": "class",
"required": false
}
],
"preferred_authoring": "fenced_block",
"purpose": "Render a public what’s-on calendar backed by the shared booking API.",
"recommended_for_agents": true,
"render_variants": [
"html",
"tex"
],
"status": "recommended",
"top_level_keys": [
"title",
"intro",
"description",
"view",
"api_base_url",
"booking_url",
"booking_label",
"owners",
"items",
"resources",
"rooms"
]
},
{
"category": "citation",
"inner_mode": "none",
"name": "cite",
"params": [
{
"kind": "positional_semicolon_list",
"name": "0",
"required": true
}
],
"purpose": "Render a citation helper.",
"recommended_for_agents": true,
"render_variants": [
"html"
],
"status": "supported"
},
{
"category": "structured",
"editor_support": "structured-block-editor",
"inner_mode": "yaml_list_or_map",
"item_fields": [
"type",
"title",
"name",
"role",
"image",
"alt",
"body",
"href",
"link_label",
"class",
"loading"
],
"name": "contact",
"params": [
{
"name": "class",
"required": false
}
],
"preferred_authoring": "fenced_block",
"purpose": "Render structured contact cards.",
"recommended_for_agents": true,
"render_variants": [
"html",
"tex"
],
"status": "recommended",
"top_level_keys": [
"items",
"cards",
"contacts"
]
},
{
"category": "internal",
"inner_mode": "none",
"name": "docs-json",
"params": [
{
"name": "file",
"required": true
}
],
"purpose": "Render a repository JSON file inside the generator documentation website.",
"recommended_for_agents": false,
"render_variants": [
"html"
],
"status": "internal"
},
{
"category": "internal",
"inner_mode": "none",
"name": "docs-source",
"params": [
{
"name": "file",
"required": true
}
],
"purpose": "Render a repository markdown file inside the generator documentation website.",
"recommended_for_agents": false,
"render_variants": [
"html"
],
"status": "internal"
},
{
"category": "media",
"inner_mode": "optional_caption_markdown",
"name": "embed",
"params": [
{
"name": "src",
"required": false
},
{
"name": "url",
"required": false
},
{
"name": "title",
"required": false
},
{
"name": "layout",
"required": false
},
{
"name": "class",
"required": false
},
{
"name": "caption",
"required": false
},
{
"name": "width",
"required": false
},
{
"name": "type",
"required": false
},
{
"name": "height",
"required": false
},
{
"name": "aspect",
"required": false
},
{
"name": "allow",
"required": false
},
{
"name": "allowfullscreen",
"required": false
},
{
"name": "sandbox",
"required": false
},
{
"name": "referrerpolicy",
"required": false
},
{
"name": "loading",
"required": false
},
{
"name": "iframeId",
"required": false
},
{
"name": "id",
"required": false
}
],
"purpose": "Render iframe and media embeds.",
"recommended_for_agents": true,
"render_variants": [
"html",
"tex"
],
"status": "recommended"
},
{
"category": "structured",
"editor_support": "structured-block-editor",
"inner_mode": "yaml_list_or_map",
"name": "faq",
"params": [
{
"name": "class",
"required": false
}
],
"preferred_authoring": "fenced_block",
"purpose": "Render structured FAQ entries.",
"recommended_for_agents": true,
"render_variants": [
"html",
"tex"
],
"status": "recommended",
"top_level_keys": [
"items",
"faqs",
"questions"
]
},
{
"category": "widget",
"editor_support": "structured-block-editor",
"inner_mode": "yaml_map",
"name": "fundalumin",
"params": [
{
"name": "title",
"required": false
},
{
"name": "class",
"required": false
}
],
"preferred_authoring": "fenced_block",
"purpose": "Render a Fundalumin campaign discovery widget backed by the shared funding app.",
"recommended_for_agents": true,
"render_variants": [
"html",
"tex"
],
"status": "recommended",
"top_level_keys": [
"title",
"intro",
"description",
"app_base_url",
"browse_url",
"browse_label",
"apply_url",
"apply_label",
"wishlist_limit",
"campaigns",
"items",
"profiles"
]
},
{
"category": "structured",
"editor_support": "structured-block-editor",
"inner_mode": "yaml_list_or_map",
"item_fields": [
"image",
"alt",
"caption",
"class",
"loading"
],
"name": "gallery",
"params": [
{
"name": "class",
"required": false
}
],
"preferred_authoring": "fenced_block",
"purpose": "Render structured gallery grids.",
"recommended_for_agents": true,
"render_variants": [
"html",
"tex"
],
"status": "recommended",
"top_level_keys": [
"items",
"images",
"figures"
]
},
{
"category": "media",
"inner_mode": "none",
"name": "icon",
"params": [
{
"kind": "positional",
"name": "0",
"required": true
}
],
"purpose": "Render a named inline icon.",
"recommended_for_agents": true,
"render_variants": [
"html"
],
"status": "supported",
"support_files": [
"json"
]
},
{
"category": "utility",
"inner_mode": "none",
"name": "include",
"params": [
{
"name": "file",
"required": true
}
],
"purpose": "Inline a raw file into the rendered output.",
"recommended_for_agents": false,
"render_variants": [
"html"
],
"status": "supported"
},
{
"category": "citation",
"inner_mode": "none",
"name": "mref",
"params": [
{
"name": "class",
"required": true
},
{
"name": "method",
"required": true
}
],
"purpose": "Link to a documented class method anchor.",
"recommended_for_agents": true,
"render_variants": [
"html"
],
"status": "supported"
},
{
"category": "widget",
"name": "purchasemembership",
"purpose": "Legacy membership purchase widget.",
"recommended_for_agents": false,
"render_variants": [
"html"
],
"status": "legacy"
},
{
"category": "widget",
"inner_mode": "none",
"name": "pydoc",
"params": [
{
"name": "src",
"required": true
},
{
"name": "class",
"required": false
}
],
"purpose": "Render Python source documentation from a file.",
"recommended_for_agents": true,
"render_variants": [
"html",
"tex"
],
"status": "supported"
},
{
"category": "widget",
"editor_support": "dedicated-quiz-editor-for-file-backed-sources",
"inner_mode": "optional_inline_model",
"name": "quiz",
"params": [
{
"name": "src",
"required": false
},
{
"name": "class",
"required": false
},
{
"name": "id",
"required": false
},
{
"name": "title",
"required": false
}
],
"purpose": "Render a quiz widget from a source file or inline model.",
"recommended_for_agents": true,
"render_variants": [
"html",
"tex"
],
"status": "recommended"
},
{
"category": "citation",
"inner_mode": "none",
"name": "references",
"params": [],
"purpose": "Render references list.",
"recommended_for_agents": true,
"render_variants": [
"html",
"tex"
],
"status": "supported"
},
{
"category": "citation",
"inner_mode": "none",
"name": "ref",
"params": [
{
"kind": "positional_variadic",
"name": "labels",
"required": true
}
],
"purpose": "Link section, equation, figure, and table references by label.",
"recommended_for_agents": true,
"render_variants": [
"html"
],
"status": "supported"
},
{
"category": "citation",
"inner_mode": "none",
"name": "pageref",
"params": [
{
"kind": "positional_variadic",
"name": "labels",
"required": true
}
],
"purpose": "Link to the composed PDF page number for section, equation, figure, and table labels.",
"recommended_for_agents": true,
"render_variants": [
"html",
"tex"
],
"status": "supported"
},
{
"category": "widget",
"inner_mode": "none",
"name": "skill-meter",
"params": [
{
"name": "widget",
"required": false
},
{
"name": "user",
"required": false
},
{
"name": "variant",
"required": false
},
{
"name": "title",
"required": false
},
{
"name": "eyebrow",
"required": false
},
{
"name": "subtext",
"required": false
},
{
"name": "class",
"required": false
}
],
"purpose": "Render the shared skill/training widget.",
"recommended_for_agents": true,
"render_variants": [
"html"
],
"status": "recommended"
},
{
"category": "structured",
"editor_support": "structured-block-editor",
"inner_mode": "yaml_list_or_map",
"name": "stats",
"params": [
{
"name": "class",
"required": false
}
],
"preferred_authoring": "fenced_block",
"purpose": "Render structured stat/metric cards.",
"recommended_for_agents": true,
"render_variants": [
"html",
"tex"
],
"status": "recommended",
"top_level_keys": [
"items",
"stats",
"metrics"
]
},
{
"category": "structured",
"editor_support": "structured-block-editor",
"inner_mode": "yaml_list_or_map",
"item_fields": [
"name",
"role",
"image",
"alt",
"bio",
"href",
"link_label",
"class",
"loading"
],
"name": "team",
"params": [
{
"name": "class",
"required": false
}
],
"preferred_authoring": "fenced_block",
"purpose": "Render structured people/team cards.",
"recommended_for_agents": true,
"render_variants": [
"html",
"tex"
],
"status": "recommended",
"top_level_keys": [
"members",
"items",
"cards"
]
},
{
"category": "structured",
"editor_support": "structured-block-editor",
"inner_mode": "yaml_list_or_map",
"name": "testimonials",
"params": [
{
"name": "class",
"required": false
}
],
"preferred_authoring": "fenced_block",
"purpose": "Render structured testimonials.",
"recommended_for_agents": true,
"render_variants": [
"html",
"tex"
],
"status": "recommended",
"top_level_keys": [
"items",
"quotes",
"testimonials"
]
}
],
"source_dir": "layouts/shortcodes",
"updated": "2026-03-20",
"version": 1
}