Frontmatter reference
Markdown frontmatter fields for guide pages.
Optional YAML block at the top of a Markdown file:
---
title: Getting started
description: Install and authenticate.
slug: getting-started
position: 10
hidden: false
---
Field | Type | Default | Description |
|---|---|---|---|
| string | From filename | Sidebar and page title |
| string | — | Short blurb under the title |
| string | Path-based from file path (for example | Path under the section; must be unique within the section |
| number | Path heuristics | Lower sorts earlier in the sidebar |
| boolean |
| Hide from navigation when true |
Unknown keys are ignored. Body Markdown follows the closing ---.
Narrative guide: Page settings.