living-library

Zero-config documentation site generator for GSD .planning folders.

Run npx @templeofsilicon/living-library in any repo with a .planning folder and instantly browse your project documentation as a clean, searchable site.

Usage

# Start dev server with live reload
npx @templeofsilicon/living-library

# Build static site for deployment
npx @templeofsilicon/living-library build

That's it. No config files, no setup.

Features

• Zero config — auto-detects .planning folder in your repo
• GSD-aware navigation — understands phases, milestones, research, todos
• Full-text search — powered by Pagefind, built at compile time
• Light/dark themes — respects system preference, toggle in header
• Milestone timeline — visualizes project history from ROADMAP.md
• Live reload — file changes reflect instantly during development
• Static build — deploy anywhere (Netlify, Vercel, GitHub Pages)

What it expects

A .planning folder with markdown files. Works great with get-shit-done project structure:

your-repo/
├── .planning/
│   ├── PROJECT.md
│   ├── ROADMAP.md
│   ├── REQUIREMENTS.md
│   ├── phases/
│   │   ├── 01-foundation/
│   │   └── 02-features/
│   └── milestones/
└── src/

But any .planning folder with markdown files will work.

CLI Options

npx @templeofsilicon/living-library [command] [options]

Commands:
  dev     Start development server (default)
  build   Generate static site to ./dist

Options:
  -v, --verbose  Show detailed output
  -h, --help     Show this help message
  --version      Show version number

Part of the development coven

• get-shit-done — AI-native project execution framework
• living-library — documentation viewer for GSD projects
• Esoterica — tarot for developers

License

MIT