Houston Docs

A small Astro docs generator.

Workspace layout:

• apps/web - Astro app, landing page, docs renderer
• packages/generator - Bun CLI and local server runner
• examples/basic/docs - source markdown examples

The web app renders copied/generated docs from apps/web/src/content/docs.

It makes:

• markdown docs in src/content/docs
• chapter navigation from frontmatter
• table of contents from headings
• copy markdown, copy URL, and raw markdown links
• /search.json, /page-tree.json, /llms.txt, and /llms-full.txt

Run

bun install
bun run examples

Open http://localhost:3333/docs.

Generate

bun run docs:sample
bun run docs:new guide/install --title "Install" --chapter "Guide" --order 2
bun run docs:tree
bun run docs:validate

docs:sample syncs examples/basic/docs into apps/web/src/content/docs.

Frontmatter

---
title: Code
description: A small code sample.
chapter: Guide
order: 2
---