Skip to content

Getting Started

Build docs on Astro where humans and agents are first-class.

Updated View as Markdown
For humans

Nimbus lets you build docs on Astro — where humans and agents are both first-class.

Philosophy

  • Humans and agents are first-class — every page ships a .md alternate, llms.txt indexes the site, AGENT.md lives at the project root.
  • You own all your code — layouts, components, styles, and content are real files in your repo. No upstream API to break.
  • Build with agentsnimbus-docs add ships in two modes: components copy as files, and features hand off a recipe the agent reads, adapts to your project, and applies.

Scaffold

npm create nimbus-docs

Pick a directory name when prompted. Choose a template (full or empty) and a deploy target. The scaffolder writes a working site to disk.

Running locally

cd my-docs
pnpm install
pnpm dev

Open the URL it prints. Edit anything in src/ — the dev server reloads.

Where to go next

Browse components

Every UI component, every variant, with copy-paste examples — at /components.

Install from the registry

nimbus-docs add <slug> copies a component into your repo.

Navigation

Type to search…

↑↓ navigate ↵ select Esc close