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

FieldTypePurpose
titlestringPage title, navigation label, metadata title source.
summarystringDescription used for metadata, search, cards, and grids.
access_tiertier nameMain page access rule. Known defaults are public, client, partner, gold_partner, platinum_partner, and admin.
productstringProduct or platform area. Also used by client-tier extension checks.
statusdraft, published, deprecatedControls visibility and deprecation treatment.
ownerstringMaintainer name used by ownership and review workflows.

Optional fields

FieldDefaultPurpose
extensions[]Product permission slugs that can grant client-tier access.
version*Version scope for a page.
tags[]Tag landing pages, metadata, and search facets.
videononeYouTube or Vimeo URL rendered above the page body.
changelogfalseMarks changelog-style pages.
last_verified_atnoneDate used by stale-content checks.
review_interval_days90Number of days before the page should be reviewed.
deprecatedfalseLegacy boolean marker. Prefer status: deprecated for visible deprecation behavior.
redirect_from[]Old paths intended to redirect to this page.
related[]Related document slugs.
nav_order0Sort order within a section.
nav_hiddenfalseHide 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.

Frontmatter Reference — Authoring Docs | Nexus Docs