Generation Script: This file is generated from script(s):
Purpose: UI template catalog, preview routes, and snippet inventory derived from canonical template sources.
Run when: Page/block templates or component registry examples change.
Important: Do not manually edit this file; run
tools/scripts/generate-ui-templates.js. Purpose: UI template catalog, preview routes, and snippet inventory derived from canonical template sources.
Run when: Page/block templates or component registry examples change.
Important: Do not manually edit this file; run
node tools/scripts/generate-ui-templates.js --write. Source of Truth
- Canonical page templates live in
snippets/templates/pages/**. - Canonical block templates live in
snippets/templates/blocks/**. - Generated VS Code snippets live in
.vscode/templates.code-snippetsand.vscode/components.code-snippets. - Direct preview routes live under
v2/templates/**and are intentionally excluded fromdocs.jsonnavigation.
Source Tree
snippets/templates
blocks
pages
Page Templates
| Template | Source | Preview | Snippet Prefix | Description |
|---|---|---|---|---|
| FAQ Page Template | snippets/templates/pages/faq-page.mdx | view | template-faq-page | Copy-ready FAQ page scaffold with canonical frontmatter and AccordionGroup structure. |
| How-To Page Template | snippets/templates/pages/how-to-page.mdx | view | lp-howto | Task-oriented page scaffold with prerequisites, steps, validation, and a next-step CTA. |
| Navigation Page Template | snippets/templates/pages/landing-and-navigation/navigation-page.mdx | view | template-navigation-page | Copy-ready navigation page scaffold with route cards for readers who need a section map. |
| Portal Page Template | snippets/templates/pages/landing-and-navigation/portal-page.mdx | view | template-portal-page | Copy-ready portal landing page scaffold with frame-mode hero content and mission cards. |
| Landing Frame Page Template | snippets/templates/pages/landing-frame-page.mdx | view | lp-landing-frame | Frame-mode landing page scaffold with hero content, start-here cards, and key-path cards. |
| OpenAPI Endpoint Template | snippets/templates/pages/openapi-endpoint-page.mdx | view | template-openapi-endpoint-page | Copy-ready OpenAPI endpoint page scaffold with canonical reference frontmatter. |
| Overview Page Template | snippets/templates/pages/overview-page.mdx | view | lp-overview | Reusable overview page scaffold with an overview section, key ideas, and related links. |
| OpenAPI Endpoint Template | snippets/templates/pages/reference-and-api/openapi-endpoint-page.mdx | view | template-openapi-endpoint-page | Copy-ready OpenAPI endpoint page scaffold with canonical reference frontmatter. |
| Reference Page Template | snippets/templates/pages/reference-page.mdx | view | lp-reference | Lookup-oriented reference scaffold with inputs, outputs, and a concrete example. |
| Multi-View Setup Template | snippets/templates/pages/setup-and-code-layouts/multi-view-page.mdx | view | template-multi-view-page | Copy-ready scaffold for setup guides that switch between platform or environment views and include nested mode tabs, code blocks, reference cards, and validation steps. |
| Troubleshooting Page Template | snippets/templates/pages/troubleshooting-page.mdx | view | template-troubleshooting-page | Copy-ready troubleshooting page scaffold with Symptom, Cause, Fix, and Verify sections. |
| Tutorial Page Template | snippets/templates/pages/tutorial-page.mdx | view | lp-tutorial | End-to-end tutorial scaffold with goals, prerequisites, steps, and follow-up links. |
Block Templates
| Template | Source | Preview | Snippet Prefix | Description |
|---|---|---|---|---|
| Comparison Matrix Template | snippets/templates/blocks/comparison-matrix.mdx | block examples | template-comparison-matrix | Reusable comparison and decision matrix for product or architecture choice pages. |
| Comparison Table Block | snippets/templates/blocks/comparison-table.mdx | block examples | template-comparison-table | Reusable comparison table block for choosing between options, workflows, or deployment paths. |
| Related Pages Cards Block | snippets/templates/blocks/related-pages-cards.mdx | block examples | template-related-pages | Reusable related-pages card group for end-of-page CTA sections. |
| Related Pages CTA Template | snippets/templates/blocks/related-pages-cta.mdx | block examples | template-related-pages-cta | Reusable related-pages block template for routing readers to the next two pages. |
Generated Outputs
docs-guide/catalog/ui-templates.mdxv2/templates/pages/**/<name>-template.mdxv2/templates/blocks/block-examples.mdx.vscode/templates.code-snippets.vscode/components.code-snippets