Pinnate Docs

GitHubApp

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

title

string

From filename

Sidebar and page title

description

string

Short blurb under the title

slug

string

Path-based from file path (for example get-started/quickstart)

Path under the section; must be unique within the section

position

number

Path heuristics

Lower sorts earlier in the sidebar

hidden

boolean

false

Hide from navigation when true

Unknown keys are ignored. Body Markdown follows the closing ---.

Narrative guide: Page settings.