Writing content
Frontmatter, markdown features, and code blocks.
Frontmatter
| Field | Required | Purpose |
|---|---|---|
title | yes | Page heading, sidebar label, and browser title |
description | no | Subtitle and meta description |
order | no | Sort weight; lower first, ties broken by title |
A missing or empty title fails the build rather than rendering an untitled
page.
Markdown
GitHub-flavoured markdown is enabled, so tables, task lists, strikethrough, and autolinks all work. Headings at level two and three are collected into the table of contents and given anchor links.
Code blocks
Annotate a fence with its language for highlighting:
```ts
export function greet(name: string): string {
return `Hello, ${name}`;
}
```Both a light and a dark theme are emitted; the browser's colour scheme decides
which is shown. Code fences are skipped when building the table of contents, so
a # comment inside a shell example will not appear there.