Quickstart

Prerequisites

Node 18+ and pnpm (npm i -g pnpm).

Create your docs

Use this repository as a GitHub template (the Use this template button), or clone it directly:

Bash

git clone https://github.com/your-org/your-docs.git
cd your-docs
pnpm install

Run it

Bash

pnpm dev

That starts the dev server at http://localhost:3001. Edit any file under content/ and the page reloads.

Add a page

Create a Markdown file anywhere under content/ — the path becomes the route:

MDX

---
title: Hello
description: My first Capsa page.
---

# Hello

This file is served at **/docs/guides/hello**.

Then add it to the sidebar in src/navigation.ts:

TypeScript

{ group: 'Guides', icon: 'book', pages: ['guides/hello'] }

Note

Pages don't have to be listed in navigation.ts to render — but only listed pages appear in the sidebar. Use { auto: 'guides' } to include a whole folder.

Build

Bash

pnpm build

The build also generates the search index, sitemap, llms.txt, and per-page Markdown into public/. Output lands in dist/.

Quickstart

Prerequisites

Create your docs

Run it

Add a page

Build

Publish