nimbus
Docs for humans and agents, built on Astro
What is it?
What it is
Nimbus scaffolds a complete Astro documentation site into your repository as editable source files (layouts, components, styles, routes, content), with the underlying tooling provided as an npm package.
Why it exists
To give developers full ownership of their documentation site while providing a first-class experience for both human readers and AI agents, including agent‑readable surfaces, search, theming, linting, and versioned docs.
Who should use it
Developers, technical writers, and devrel teams who want full ownership of their documentation source code, prefer Astro/TypeScript stack, and need agent‑readable docs (LLM‑friendly) alongside human readers.
Who should avoid it
Users looking for a zero‑config hosted docs service, those unfamiliar with Astro or TypeScript, or projects that only need simple static markdown without customization.
How it works
A quick walkthrough in plain English
How nimbus works
Step 1 of 3
You interact with it
Open nimbus, send a request, or connect it to your stack.
Features
Advantages
- High customizability since all code is local and editable
- Optimized for both human readers and AI agents
- Zero-dependency feel for UI components once scaffolded
- Seamless deployment to Cloudflare via Wrangler
- Strong developer experience with hot reloading and type-checking
Disadvantages
- Pre-1.0 status (0.x) means breaking changes are possible
- Work in progress with potential rough edges
- Requires version pinning to avoid breaking updates
Installation
cloud
pnpm build pnpm run deploy
docker
not found
native
npx @cloudflare/create-nimbus-docs@latest my-docs cd my-docs pnpm install pnpm dev
compose
not found
FAQ
How do I create a new Nimbus documentation site?
Run `npx @cloudflare/create-nimbus-docs@latest my-docs` (replace `my-docs` with your project name), then `cd my-docs`, install dependencies with your package manager, and start the dev server with `pnpm dev` (or the equivalent command for your chosen manager).
Can I skip the interactive prompts when scaffolding a site?
Yes. Add the `--yes` flag to the create command, e.g., `npx @cloudflare/create-nimbus-docs@latest my-docs --yes`. This uses npm as the default package manager; you can specify another with `--package-manager pnpm` (or `yarn`/`bun`).
What are the most common development commands in a Nimbus project?
Inside your project you can run: - `pnpm dev` – start the dev server with hot reload - `pnpm build` – produce a static site in `dist/` - `pnpm preview` – preview the built site locally - `pnpm typecheck` – run Astro’s type check - `pnpm lint:docs` – lint prose and MDX (add `--fix` to auto‑fix)
How do I deploy my Nimbus site to Cloudflare?
After building with `pnpm build`, run `pnpm run deploy` (which executes `wrangler deploy`). The default scaffold includes a `wrangler.jsonc` configured for Cloudflare Pages or Workers.
How can I add optional components or features like a dialog or custom 404 page?
Use the Nimbus add command from your project root, for example: - `pnpm dlx @cloudflare/nimbus-docs add dialog` - `pnpm dlx @cloudflare/nimbus-docs add 404-page` Each adds editable source files (or an agent‑handed recipe) directly into your repo.
What does Nimbus provide out of the box for both humans and AI agents?
Nimbus gives you owned source files (layouts, components, content, styles, theme tokens) plus an agent‑readable surface: `.md`/`.mdx` twins for every page, `/llms.txt` and `/llms-full.txt`, JSON‑LD, sitemap, `robots.txt`, and per‑page OG images, so coding agents can consume your docs as easily as a browser.
Featured in Videos
YouTube tutorials and walkthroughs for nimbus
Alternatives
Similar projects ranked by category, topics, and text overlap.
