| Flag a note / warning / tip | Callout (<Note> <Tip> <Warning> <Info> <Success> <Error> <Launch> <Check>) | In .md, use > [!NOTE] syntax instead (see above). |
| Collapse FAQs / optional detail | Accordion / AccordionGroup | Content stays SEO-indexed while collapsed. |
| Sequence a tutorial / setup | Steps / Step | Auto-numbered, anchor links. Use toc to surface in the TOC. |
| Show the same thing per-language / per-OS | Tabs / Tab | language= syncs all tabs+code blocks site-wide. |
| Navigation grid / feature hub | Card / CardGroup | cols={n}, Font Awesome icons, images, href makes the whole card clickable. |
| Rich code (highlight, focus, title, embed a file) | Code block / <Code> / <CodeBlocks> / <CodeGroup> | Fenced ``` with attrs; <Code src> embeds local/GitHub files. |
| Multiple install commands (npm/pnpm/yarn) | CodeGroup with for= | Custom sync group independent of language. |
| Image with caption / framing | Frame | Wraps <img>/<video>; background="subtle". |
| Long / searchable / sticky-header table | StickyTable / SearchableTable / StickySearchableTable, or <table sticky searchable> | Plain Markdown tables are fine for short data. |
| Inline status / version chip | Badge | For longer notes use a Callout instead. |
| Small icon inline / in headings | Icon | Font Awesome name or ./path.svg. |
| Clickable button / CTA / download trigger | Button | intent, href, icons. |
| Downloadable asset (PDF, ZIP bundle) | Download | src= single file, sources={[…]} zips multiple. |
| Click-to-copy inline text | Copy | Show one value, copy another via clipboard=. |
| Hover explanation for a term or code token | Tooltip / <Template> | <Template> adds tooltips to code-block variables. |
| Document a param / field / config key | ParamField | The standard field-doc row: path, type, required, default, deprecated. |
| Indent nested params visually | Indent | Wraps any content (unlike <Folder>). |
| Show a project / directory tree | Files / Folder / File | defaultOpen, href, highlighted, comment. |
| Link to non-heading content | Anchor | id= on paragraphs, tables, code blocks. |
| Float supplementary content right | Aside | Sticky; good for an endpoint snippet beside prose. |
| Copyable AI prompt (open in Cursor/Claude/ChatGPT) | Prompt | actions={["cursor","claude","chatgpt"]} or custom URL. |
| Show/hide by product, version, or role | If | products / versions / roles, combinable, not to invert. |
| Inline versioned content with a switcher | Versions / Version | Distinct from site-wide versioning. |
| API reference — request code sample | EndpointRequestSnippet | endpoint="POST /path"; languages, payload, hideTryItButton. |
| API reference — response sample | EndpointResponseSnippet | Pulls from your API definition. |
| API reference — endpoint schema (params/body) | EndpointSchemaSnippet | selector="request.body" etc. |
| API reference — any named type | Schema / SchemaSnippet | <Schema type="…"> fields; <SchemaSnippet> JSON. |
| API reference — live "try it" request builder | RunnableEndpoint | Real HTTP calls from the page. |
| API reference — webhook payload | WebhookPayloadSnippet | By operationId. |
| Reuse a Markdown fragment in many places | <Markdown src> (reusable snippets) | Single-source constants/warnings; supports {{params}}. |
| Something bespoke / interactive | Custom React component | .tsx in a components dir wired via docs.yml; SSR'd. |