Folder-derived navigation
The sidebar is built entirely from your content folder. There is no nav config file to write or keep in sync — move a file, and the navigation follows.
How the tree maps to the sidebar
- content/
- 01-getting-started/
- 01-introduction.md
- 02-quick-start.md
- 02-authoring/
- index.md
- 01-callouts.md
- 01-getting-started/
- First-level folders become sidebar groups, titled after the folder name.
- Files in a folder become that group's items.
- Top-level files (directly in the content root) appear above the groups, ungrouped.
- A folder's
index.mdbecomes a reachable "Overview" item for that section, served at the folder's URL.
Nesting
Folders can nest, and so does the sidebar — up to three levels deep (level 1 is a top-level folder, level 3 is a folder three deep):
- content/
- reference/ — level 1, section heading
- api/ — level 2, collapsible sub-section
- auth.md
- webhooks/ — level 3, collapsible sub-section
- events.md
- api/ — level 2, collapsible sub-section
- reference/ — level 1, section heading
Levels 2 and 3 render as collapsible sub-sections; the branch containing the page you're on opens automatically. Anything nested deeper than three levels flattens into the third-level section — the page keeps its full URL, the sidebar just stops indenting.
Every group in this sidebar is a top-level folder. Add a subfolder and it becomes a collapsible sub-section beneath its parent.
Titles
By default a title is derived from the filename: quick-start.md becomes "Quick start". Override it per page with frontmatter — see Ordering & titles.
The home page
The site root (/) is a generated hero listing your sections as cards; it is not a content file. Lead your first group with an introduction page, the way these docs open with Introduction.
Section icons
Each card shows a default glyph unless the section's index.md sets an icon: in its frontmatter. It stays on that one page — no separate asset folder — and accepts three forms:
---
icon: "🚀" # an emoji
# icon: '<svg viewBox="0 0 24 24">…</svg>' # inline SVG (one line)
# icon: /icons/rocket.svg # a file under static/
---
The cards in this site's home page are all driven this way — every top-level section here sets an emoji icon in its index.md.
Links are validated against the filesystem when the site is built, so a stale link surfaces as a clear 404 during the build rather than a broken page in production.