Writing content
Content blocks
Every block type the renderer understands, demonstrated.
Pages are built from five block kinds. Paragraphs and list items support inline code spans with backticks; everything else renders as written.
Headings
A heading block renders as a linkable subsection title — each one gets an anchor id derived from its text.
Lists
- Unordered by default — set
ordered: truefor numbered steps. - Items support inline
codejust like paragraphs. - Keep items short; use a paragraph for anything longer.
Code
A code block renders in a scrollable panel with a copy button. language shows as a label, and filename (when set) takes its place.
{
kind: 'code',
language: 'bash',
filename: 'terminal', // optional — shown instead of the language
code: 'npm install my-lib',
}Callouts
Note: A note callout, for asides and helpful context.
Warning: A warning callout, for sharp edges the reader must not miss.