Document frontmatter
Every document in this documentation starts with a YAML frontmatter block.
Fields
| Field | Type | Required | Description |
|---|---|---|---|
title | string | yes | Page title, used in navigation and search. |
description | string | yes | One-line summary, used for SEO and search snippets. |
template | enum | no | how-to, reference, concept, release-note, or index. Default concept. |
order | number | no | Navigation order within the folder (fallback when no _meta.json entry exists). |
tags | string[] | no | Free-form tags. |
audience | enum | no | both (default), human, or agent — whole-page audience. |
draft | boolean | no | true excludes the page from build and index. |
version | string | no | Product version this page documents. |
updated | date | no | Last meaningful content update. |
hide_toc | boolean | no | Hide the on-page table of contents. |
Audience blocks
Inside the body, :::human and :::agent fence audience-specific blocks; everything outside is shared. :::include{snippet="name"} inlines a snippet from templates/snippets/.