What is this?
Nimbus is an authoring tool for docs, built on Astro. It creates a docs site inside your repo, checks what you and your agents write, and publishes HTML for people plus Markdown for agents.
Nimbus is an authoring tool for docs, built on Astro. It creates a docs site inside your repo, checks what you and your agents write, and publishes HTML for people plus Markdown for agents.Is it a library or a ready-made docs site?Both sides: the scaffolder copies the site code (layouts, components, routes, content) into your repo where you can edit it, while the @cloudflare/nimbus-docs package supplies the Astro integration, helpers and CLI.
Both sides: the scaffolder copies the site code (layouts, components, routes, content) into your repo where you can edit it, while the @cloudflare/nimbus-docs package supplies the Astro integration, helpers and CLI.How do I get it running?You need Node.js 22.12.0 or later. Create a site with the @cloudflare/create-nimbus-docs package, write pages in src/content/docs/ as MDX or Markdown starting with index.mdx, and set the site URL, title and description in astro.config.ts, which ship as placeholders.
You need Node.js 22.12.0 or later. Create a site with the @cloudflare/create-nimbus-docs package, write pages in src/content/docs/ as MDX or Markdown starting with index.mdx, and set the site URL, title and description in astro.config.ts, which ship as placeholders.Is it stable enough to rely on?It is pre-1.0, so the public API can change between minor releases. Pin your versions and read the nimbus-docs and create-nimbus-docs changelogs before each upgrade.
It is pre-1.0, so the public API can change between minor releases. Pin your versions and read the nimbus-docs and create-nimbus-docs changelogs before each upgrade.Do I have to host it on Cloudflare?No. Static builds can go anywhere. Cloudflare, Netlify, Vercel and Node are only needed for on-request rendering and the remote MCP server.
No. Static builds can go anywhere. Cloudflare, Netlify, Vercel and Node are only needed for on-request rendering and the remote MCP server.Can it pull docs from other sources?Yes. It supports docs versions and search, and it can load pages from other Git repositories or from Notion.
Yes. It supports docs versions and search, and it can load pages from other Git repositories or from Notion.Which MDX components come built in?Code blocks, tabs, steps, cards, file trees, reusable snippets and interactive diagrams. Some of them install on demand with nimbus-docs add.
Code blocks, tabs, steps, cards, file trees, reusable snippets and interactive diagrams. Some of them install on demand with nimbus-docs add.Does a lint warning stop my build?No. nimbus-docs lint reports authoring mistakes using rules from astro.config.ts, but it does not block the build.
No. nimbus-docs lint reports authoring mistakes using rules from astro.config.ts, but it does not block the build.What are similar projects?redoc, buildawesome, openwiki, mdBook, docusaurus, vibex, context7, fumadocs
redoc, buildawesome, openwiki, mdBook, docusaurus, vibex, context7, fumadocsWhich topics is it in?documentation-generator, documentation-tool, static-site, static-site-generator, openapi, cloudflare, documentation, markdown, npm, mcp, tool, library
documentation-generator, documentation-tool, static-site, static-site-generator, openapi, cloudflare, documentation, markdown, npm, mcp, tool, library