Introduction
How it works#
- Write pages as
.mdx (or .md) files under content/docs
- Describe the site once in
docs.json
- Build to plain HTML with
pnpm build — every page is prerendered, then hydrated into a client-side app for instant navigation
What you get#
- Validated configuration — supported
docs.json keys are checked against a schema, with clear errors for unknown or malformed options
- Site chrome — navbar links and buttons, footer socials and link columns, and a dismissible announcement banner
- Theming — light and dark modes, accent colors, custom fonts, and backgrounds
- SEO built in — canonical URLs, Open Graph tags, structured data,
sitemap.xml, redirects, and last-modified timestamps pulled from git history
- Docs components — callouts, tabs, steps, cards, and code groups, available on every page without imports
Get started#
