Quickstart

Run the site locally and publish your first page.

Requirements

Node 20 or newer and pnpm 10.

Install and run

pnpm install
pnpm dev

The site is served at http://localhost:3000. The root path redirects to /docs.

Add a page

Create an MDX file under content/docs/. Every page needs a title in its frontmatter:

---
title: Deploying
description: Ship the site to your own cluster.
---
 
Your content here.

Then reference it from content/docs.json so it appears in the sidebar:

{
  "group": "Guides",
  "pages": ["guides/writing-content", "deploying"]
}

The page path is its file path without the .mdx extension. index.mdx addresses its parent directory, so content/docs/index.mdx has the path "".

Verify before shipping

pnpm typecheck   # types
pnpm test        # content layer unit tests
pnpm build       # production build, catches broken MDX

A malformed frontmatter block or an invalid docs.json fails the build with the offending file named, rather than producing a broken page.