Frontmatter Reference

Frontmatter is the YAML block at the top of a markdown or MDX page. Prestige reads it for page metadata and uses it when building the document title, description, sidebar labels, and extra head tags.

---
title: Overview
description: Learn how the architecture works.
label: Overview
---

Frontmatter object

title

Type: string

Required page title. Prestige uses it to generate the browser title as {title} | {siteTitle}.

description

Type: string

Optional page description. When set, Prestige adds it as the page meta[name="description"].

label

Type: string

Optional sidebar label for the page. This is especially useful for autogenerated navigation where you want a label different from the file name.

Type: ContentHeadFrontmatter

Optional extra head configuration. Use it to append custom meta tags, links, styles, or scripts to a page.

ContentHeadFrontmatter

The head object is forwarded into the TanStack Router route head() result for that page.

meta

Type: Array<Record<string, any>>

Additional meta entries appended after Prestige's generated title and description metadata. Use this for Open Graph, Twitter, robots, and similar tags.

Type: Array<Record<string, any>>

Additional link entries for the page head, such as canonical URLs, alternate links, icons, or stylesheets.

styles

Type: Array<Record<string, any>>

Additional inline style descriptors for the route head.

scripts

Type: Array<Record<string, any>>

Additional script descriptors for the route head.

Notes

  • title is the only required frontmatter field.
  • If label is omitted, Prestige falls back to the configured collection label or the file basename when it needs a sidebar label.
  • head.meta is merged with Prestige's generated metadata, so the built-in title and description handling still runs first.