Nimbus is an authoring tool for docs, built on Astro. It creates a docs site in your repo, checks the content you and your agents write, and publishes it as HTML for people and Markdown for agents.
Docs: nimbus-docs.com
Requires Node.js 22.12.0 or later.
npx @cloudflare/create-nimbus-docs@latest my-docs --yes --package-manager npm
cd my-docs
npm run devPages live in src/content/docs/ as MDX or Markdown. Start with src/content/docs/index.mdx, and set the site's URL, title and description in astro.config.ts; they ship as placeholders.
- Your repo holds the site: layouts, components, styles, routes and content, copied in by the scaffolder. Edit any of it.
@cloudflare/nimbus-docsis the dependency: the Astro integration, the helpers your routes call, and thenimbus-docsCLI.- The registry holds optional components and features.
nimbus-docs addcopies components in as source; features are Markdown recipes a coding agent applies to your project.
Writing:
- MDX components: code blocks, tabs, steps, cards, file trees, reusable snippets and interactive diagrams. Some install on demand with
nimbus-docs add. - An API reference generated from OpenAPI 3.x, including multiple API versions.
- Docs versions, search, and pages loaded from other Git repositories or Notion.
Checking:
- Config, frontmatter and MDX components are validated during the build.
nimbus-docs lintreports authoring mistakes with rules configured inastro.config.ts. It doesn't block the build.nimbus-docs checkchecks the environment, structure, content, types and pending upgrades without building.--fixapplies safe fixes;--jsongives an agent the findings.
Publishing for agents:
- Markdown versions of docs and API reference pages, plus
llms.txtandllms-full.txt. Hidden versions are left out. - Optional Agent Skills, WebMCP search and a remote MCP server.
Sites are static by default: npm run build, then host the output anywhere. Rendering pages on request and the remote MCP server need a server adapter (Cloudflare, Netlify, Vercel or Node); see Deploy.
| Package | What it is |
|---|---|
@cloudflare/create-nimbus-docs |
Creates a new site. |
@cloudflare/nimbus-docs |
The Astro integration and the nimbus-docs CLI. |
Pre-1.0. The public API can change between minor releases. Pin your versions and read each package's changelog (nimbus-docs, create-nimbus-docs) before upgrading.
Start with an issue or a discussion. Once a maintainer approves it, your pull requests go through normal review. See CONTRIBUTING.md, and CLAUDE.md for the architecture and agent context.