Getting started

Quick start

Make your first documentation edit in under a minute.

Open lib/docs-content.ts and find the DOCS array. Every section, page, and paragraph on this site comes from that one tree.

Add a page

Append a page object to any section. The sidebar entry, the URL, and the prev/next links are derived automatically.

lib/docs-content.ts

{
  slug: 'my-first-page',
  title: 'My first page',
  description: 'A one-line summary shown under the title.',
  blocks: [
    { kind: 'paragraph', text: 'Hello docs! Inline `code` uses backticks.' },
  ],
},

Preview it

bash

npm run dev
# then open http://localhost:3000/docs

Warning: Slugs become URLs. Keep them lowercase kebab-case and unique — renaming a slug changes the page address.