Configuration overview
Site-level and page-level settings for Pinnate docs.
Pinnate docs configuration splits into two layers:
Layer | Where | What it controls |
|---|---|---|
Site |
| Title, theme, visibility, top nav, embeds, excludes, navbar links |
Page | Markdown frontmatter | Title, description, slug, sidebar order, hidden |
Site level
Start with Site settings. When sections: is present in site.yaml, that list is the source of truth for top navigation on each sync.
Page level
Every guide page can declare page settings in YAML frontmatter. Discovery builds the sidebar from folders and position.
Navigation model
Navigation covers guide sections, embed sections, groups (children), discovery vs explicit pages:, and public URL shapes.
Not yet available
Some site-structure features common in large portals are still on the roadmap:
Doc versions (distinct from registry versions)
Organize multiple product areas with sections and groups — that is the supported multi-product model.