Frontmatter Patterns

The fields below are enough to get most pages right without overthinking configuration.

Minimal page

---
title: Page Title
description: One-sentence summary of the page.
---

Useful fields to learn first

template

Use template: splash for landing pages like the homepage.

Leave the default doc layout for normal content pages.

tableOfContents

Set tableOfContents: false on short runbooks and checklists where the right rail would just be noise.

editUrl

Set editUrl: false if a page should not show an edit link.

sidebar.badge

Use this to label pages like new, stub, or recommended.

sidebar:
  badge:
    text: stub
    variant: tip

hero

Use hero only on splash pages that need a landing-page feel.

hero:
  tagline: Short supporting sentence.
  actions:
    - text: Start Here
      link: /docs/guides/getting-started/
      icon: right-arrow

Advice

• Put the real page summary in description; it helps readers and metadata.
• Avoid heavy frontmatter unless the page actually needs it.
• Keep layout decisions boring and consistent until the content model is stable.