Writing docs
Write documentation in content/docs/ and posts in content/blog/.
Pages share the same Markdown pipeline and components. No per-file imports are needed.
Frontmatter#
Docs require title, section and numeric order; description is optional.
Blog posts require title, description, quoted date (YYYY-MM-DD), author, tags (a list), and boolean draft. image is optional. The author is a key in content/blog/authors.json. Drafts appear in development and are omitted from production.
Callouts#
Tabs#
Wrap named <Tab title="…"> panels in <Tabs label="…">.
Use Left/Right arrows, Home and End to select a tab. Every panel remains readable without JavaScript.
macOS
Install the macOS package with your preferred package manager.
Linux
Install the Linux package for your distribution.
Windows
Install the Windows package and open a terminal.
Code groups#
Use <CodeGroup> with <Tab title="…"> children to compare code samples.
All code fences have copy buttons; unknown languages render as plain text.
TypeScript
const response = await fetch('/api/status');
console.log(await response.json());Python
import urllib.request
print(urllib.request.urlopen('/api/status').status)Steps#
Use level-three headings inside <Steps> to number a sequence. Keep blank lines around Markdown inside components.
Create a file#
Add a Markdown file in the appropriate content folder and fill in its frontmatter.
Preview the page#
Run npm run dev and check the content in light and dark mode.
Publish#
For posts, set draft: false. Run npm run build to validate all content.
Heading links#
Headings generate stable IDs. Level-two through level-four headings include a permalink. Repeated headings receive numbered suffixes; formatting is preserved in the text and removed from the ID.