5Get started

Frontmatter

The fields a page can set in the YAML block at its top.

Every page in docs/ starts with a frontmatter block. Only title is needed:

---
title: Rotate an API key
lede: Replace a key without downtime.
description: How to rotate an Acme API key without breaking live traffic.
last_updated: 2026-11-08
---

Fields not listed here are ignored. Some layouts ignore some fields too: landing pages use only title, description and layout, and hub pages show no breadcrumbs or related pages.

Page text

titlestringrequired

The page heading and the browser tab title, which reads title · site name unless seo.titleTemplate says otherwise. Search and related-page lists use it too.

ledestring

A line under the title. Search indexes it, and llms.txt lists it beside the page's link.

descriptionstring

The meta description for search engines and link previews. Unset, the lede is used, then seo.description.

last_updatedstring

Shown as "Last updated …" at the foot of the page, or beside the page actions with layout.pageActions: "menu". A date written as 2026-11-08 shows as "November 8, 2026". Put it in quotes, or write any other text, to show it exactly as written.

On this page

tocarray | false | "steps"

Unset, "On this page" lists the page's ## and ### headings. A list of { id, label } replaces it; false hides it; steps adds the title of every <Step>. See On this page.

crumbsarray

Replaces the breadcrumb trail built from the sidebar. Each item is { label, href? }; one without href isn't a link.

crumbs:
  - label: Guides
    href: /guides
  - label: Webhooks
relatedstring[]

Paths of pages listed under "Related articles" at the end, shown by their titles, e.g. [/billing/plans, /billing/invoices]. See layout.related.

A page can't set its own previous and next links; they follow the sidebar. See Previous and next links.

Layout

layout"doc" | "landing" | "hub"

doc (default) has the sidebar and "On this page". landing is full width for landing pages. hub puts a hero with a large search box above the page. See Page layouts.

heroobject

hub pages only: image, imageStyle, background, text, align and placeholder (the search box's text). See Page layouts.

sidebarboolean

false hides the sidebar on desktop so the page uses the full width. Phones still have it in the menu.

Ask AI

aiSuggestionsstring[]

Up to three starter questions for the Ask AI panel on this page. They replace generated or default ones.

Changelog entries

Files in changelog/ have their own fields: date, title, tags and breaking. See Changelog.

Edit this page on GitHub