Frontmatter Reference

Every docs page should use the supported frontmatter subset.

1---2title: Installation3navTitle: Install4description: Install and configure payload-markdown-docs.5order: 106status: published7tags:8  - getting-started9redirectFrom:10  - /docs/install11---

Supported Fields

• title
• navTitle
• description
• order
• status
• slug
• tags
• redirectFrom
• draft

Rules

• status must be draft or published
• order must be a number
• tags and redirectFrom must use list item syntax
• slug may contain letters, numbers, and hyphens
• unknown fields produce warnings
• nested YAML objects are not supported
• arrays must be written as block lists, not inline arrays
• draft must be true or false
• title, navTitle, description, and slug are plain strings

Formatting Expectations

Frontmatter is parsed with a deliberately small YAML subset so docs stay easy to review in Git and predictable in CI.

Use this shape:

1---2title: Quick Start3navTitle: Quick Start4description: Run the default docs workflow.5order: 206status: published7tags:8  - getting-started9---

Do not use this shape:

1---2title:3  text: Quick Start4tags: [getting-started, workflow]5hero:6  image: /hero.png7---

Unsupported keys are ignored with warnings. Unsupported syntax that cannot be parsed fails validation.

Route Fields

The file path controls the default route:

• index.md routes to the docs set route base
• getting-started/quick-start.md routes below the docs set route base
• slug: quickstart changes only the final route segment

Do not use slug for nested paths. Move or rename the file when the route hierarchy changes.