notabene · note this well
EN
On this page

Frontmatter

Optional YAML at the very top of a page. Everything has a sensible default — a repo with zero frontmatter renders fine (humanized file names, alphabetical order).

---
title: Internal network map        # page <title> + breadcrumb (overrides the first H1)
description: Segments and VLANs.   # public builds: meta description + OpenGraph + JSON-LD
publish: false                     # public builds: keep this page out entirely
lastUpdated: 2026-05-04            # page footer: overrides the git "Updated on" date
sidebar:
  label: Network map               # sidebar text (else title, else humanized file name)
  order: 9                         # position among siblings (ascending)
  indexLabel: Start here           # folder landing pages: rename the "Overview" entry
---
KeyEffect
titlePage <title>, breadcrumb, search result title. Falls back to the first # H1, then the file name
descriptionPublic builds: <meta name="description">, OpenGraph/Twitter description, JSON-LD
publish: falsePublic builds: the page is not built — no route, nav, search, llms, twin, sitemap. Dev/normal builds always show it
lastUpdatedOverrides the git-derived date in the page footer’s Updated on. Any date YAML can parse. Useful when git history misleads (imported or generated content)
sidebar.labelSidebar entry text. Resolution: sidebar.labeltitle → humanized file name
sidebar.orderSort key among siblings, ascending. Unset entries keep alphabetical order, after the ordered ones. Groups and pages share one ordering
sidebar.indexLabelOn a folder’s landing page: renames its localized Overview entry

Folders

A folder is named and positioned by its landing page — <folder>/index.md (or readme.md): its sidebar frontmatter applies to the whole group, and the page itself appears as the group’s Overview entry. Labels and order flow through to breadcrumbs and PDF covers.

Unknown keys are ignored and preserved — agents editing a page must keep the existing frontmatter intact (the review skill does).

Updated Edit this page