Skip to content

Frontmatter fields

Every page needs a title. Everything else is optional.

Field Purpose
title Page heading and sidebar label. Required.
description Used for <meta> tags and search results.
sidebar.order Sort position within its section. Lower comes first.
sidebar.label Override the sidebar text when it should differ from the title.
sidebar.badge Small badge next to the entry, e.g. New or Draft.
sidebar.hidden Keep the page reachable by URL but out of the sidebar.
tableOfContents Set to false to hide the right-hand outline.
draft Set to true to exclude the page from production builds.

A page using several of them:

---
title: Migrating the cluster
description: Steps for the 2026 cluster migration.
sidebar:
order: 3
label: Cluster migration
badge:
text: New
variant: tip
---

The full list is in the Starlight frontmatter reference.