Get started

Four steps. An afternoon.

Clone the repo. Write your MDX. Run ingest. Ship.

Step 01

Clone the repo

One Next.js project. Components, ingest script, search route, and chat panel all included.

Step 02

Write your docs in MDX

Add files to content/docs/. Wrap retrievable units in <Chunk id>. 50–500 chunks is the sweet spot.

Step 03

Run ingest

npm run ingest builds data/docs.db with embeddings and metadata. Re-run any time MDX changes; it's idempotent.

Step 04

Ship

npm run build && npm start. Push to your existing static host plus a serverless runtime.

terminal · minimum viable adoption

# 1. Clone the reference
git clone https://github.com/getdoks/doks
cd doks && npm install

# 2. Edit MDX under content/docs/
$EDITOR content/docs/index.mdx

# 3. Build the index
VOYAGE_API_KEY=… npm run ingest

# 4. Ship
npm run build && npm start

What's in the box

Built end-to-end.

Everything below is wired and shipping in v0.1.

MDX content with frontmatter-driven nav, ordering, badges, and TOC
<Chunk> retrieval markers: the unit your retriever returns
Voyage AI embeddings with a deterministic hash fallback for offline runs
sqlite-vec index stored as one file at data/docs.db
Semantic + lexical search via /api/docs/search
⌘K Spotlight that calls the search route
"Ask the docs" chat panel: multi-turn, streamed, with chunk citations
Recursive sidebar nav: folders nest, top-level docs sit beside groups
Right rail TOC with live active-heading tracking
Mobile drawers: left for nav, right for page menu
Theme toggle: light, dark, blue-pearl, sand
MDX components: Hero, QJump, QCard, Callout, Tabs, Steps, CodeBlock
Copy-page-as-Markdown button for LLM-friendly sharing
Prev / next neighbor links from the doc tree

Legal