ContributingDocs site
Frontmatter and headings
The frontmatter gives the title and the description of a page. The headings make the table of contents.
---
title: Deploys
description: How a deploy goes from queued to live with zero downtime.
icon: Rocket
---
The body, in Markdown, with the components below.
## Health checks
…The frontmatter is the block between the two --- lines.
The fields
| Field | Value |
|---|---|
title | Required. |
description | One sentence of plain text, with no Markdown. It shows under the title, in the search and in the Open Graph images. |
icon | Optional. The name of a lucide icon. |
full: true | Optional. It makes a wide page. |
Do not write the title again as a # heading.
Headings
## and ### headings make the "On this page" table of contents.
Each heading gets an anchor: its text in lower case, with - for each space. For example, ## Health checks becomes #health-checks.