1 min readMay 15, 2026by maintainer
Frontmatter Reference
Every page must begin with YAML frontmatter. The schema is defined in src/lib/content/frontmatter.ts and validated before a page is loaded.
Required fields
| Field | Type | Purpose |
|---|---|---|
title | string | Page title, navigation label, metadata title source. |
summary | string | Description used for metadata, search, cards, and grids. |
access_tier | tier name | Main page access rule. Known defaults are public, client, partner, gold_partner, platinum_partner, and admin. |
product | string | Product or platform area. Also used by client-tier extension checks. |
status | draft, published, deprecated | Controls visibility and deprecation treatment. |
owner | string | Maintainer name used by ownership and review workflows. |
Optional fields
| Field | Default | Purpose |
|---|---|---|
extensions | [] | Product permission slugs that can grant client-tier access. |
version | * | Version scope for a page. |
tags | [] | Tag landing pages, metadata, and search facets. |
video | none | YouTube or Vimeo URL rendered above the page body. |
changelog | false | Marks changelog-style pages. |
last_verified_at | none | Date used by stale-content checks. |
review_interval_days | 90 | Number of days before the page should be reviewed. |
deprecated | false | Legacy boolean marker. Prefer status: deprecated for visible deprecation behavior. |
redirect_from | [] | Old paths intended to redirect to this page. |
related | [] | Related document slugs. |
nav_order | 0 | Sort order within a section. |
nav_hidden | false | Hide from menus while keeping the page routable. |
Minimal page
YAML
---
title: "Install Nexus Docs"
summary: "Prepare the app, database, worker, and search service."
access_tier: public
product: platform
status: published
owner: maintainer
tags: [install]
nav_order: 10
---Client-gated page
YAML
---
title: "Customer Configuration"
summary: "Configuration available to customers with the matching product grant."
access_tier: client
product: nexus/customer-portal
status: published
owner: maintainer
extensions: [nexus/customer-portal]
tags: [configuration]
nav_order: 20
---For client pages, access requires both sufficient tier rank and a matching product or extension permission. Partner-tier users and above bypass extension checks.
Hidden utility page
YAML
---
title: "Reusable Release Notes Snippet"
summary: "Internal reusable content linked from release pages."
access_tier: public
product: platform
status: published
owner: maintainer
nav_hidden: true
---Use hidden pages for content that should be linked directly but should not appear in sidebar navigation, grids, or section menus.