Skip to content
Esc
↑↓navigate↵open⌘Jpreview
On this page

Frontmatter

All supported page metadata fields, defaults, and validation rules.

Frontmatter is the YAML block between --- fences at the very beginning of a file. It describes the page rather than its prose. All fields are optional; explicit titles and descriptions make the result easier to maintain.

---
title: Logo clearspace
description: The protected area around our logo.
slug: protected-area
draft: false
hidden: false
icon: ph:bounding-box
noindex: false
sidebar:
  label: Clearspace
  icon: ph:ruler
  badge: Updated
  hidden: false
seo:
  title: Logo clearspace guidelines
  description: Learn the minimum clearspace for our approved logo artwork.
  canonical: https://brand.example.com/logo/protected-area
  image: /images/logo-social.png
  noindex: false
---
PropType
title?string

Page title and default sidebar label. Without it, the scanner humanizes the filename; do not depend on a heading in the body for the title.

Typestring
description?string

Page summary and default metadata description.

Typestring
slug?string

Replaces the final URL segment within the current folder. Use letters or numbers separated by single hyphens; Unicode letters and numbers work. Slashes, spaces, underscores, and leading or trailing hyphens are rejected. An index page cannot override its slug.

Typestring
draft?boolean

Included during development; omitted from normal builds and checks. Use check --preview to check drafts.

Typeboolean
Defaultfalse
hidden?boolean

Shorthand for hiding the page in the sidebar. The page remains published.

Typeboolean
Defaultfalse
icon?string

Default sidebar icon name from the bundled Phosphor icon set.

Typestring
noindex?boolean

Shorthand for seo.noindex.

Typeboolean
Defaultfalse
sidebar.label?string

Overrides the navigation label.

Typestring
sidebar.icon?string

Overrides the page-level icon. Bare Phosphor names and ph: names are accepted.

Typestring
sidebar.badge?string

Adds a badge to the sidebar entry.

Typestring
sidebar.hidden?boolean

Omits the entry from the sidebar.

Typeboolean
seo.title?string

Overrides the title passed to the page layout, including its displayed title and document metadata.

Typestring
seo.description?string

Overrides the description passed to the page layout.

Typestring
seo.canonical?string

Overrides the canonical URL.

Typestring
seo.image?string

Custom social image path or URL; takes precedence over the generated image. See Social cards and SEO.

Typestring
seo.noindex?boolean

Emits a robots instruction to avoid indexing this page.

Typeboolean
Defaultfalse

The schema is strict: unknown fields cause a validation error. For example, Brandtree does not accept sidebar.order, layout, date, tags, or arbitrary custom metadata. This documentation app’s sidebar.order belongs to its Blume host. For a Brandtree site, use numeric filenames or folder metadata as described in Navigation.

Setting top-level hidden: true or noindex: true takes effect even if the corresponding nested value is false. Hidden and noindex pages are still public URLs; neither setting provides access control.

See Pages and MDX to write a page, Navigation to organize it, and Social cards and SEO to control its metadata.

Was this page helpful?