README проекта с github.com/cloudflare/nimbus. Одним файлом markdown: README.md.
Nimbus is a documentation framework for Astro: docs for humans and agents, in your repo. It scaffolds the site into your repository, 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.23.4 or later.
npx @cloudflare/create-nimbus-docs@latest my-docs --yes --package-manager npm
cd my-docs
npm run dev
Pages 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.
@cloudflare/nimbus-docs is the dependency: the Astro integration, the helpers your routes call, and the nimbus-docs CLI.nimbus-docs add copies components in as source; features are Markdown recipes a coding agent applies to your project.Writing:
nimbus-docs add.Checking:
nimbus-docs lint reports authoring mistakes with rules configured in astro.config.ts. It doesn't block the build.nimbus-docs check checks the environment, structure, content, types and pending upgrades without building. --fix applies safe fixes; --json gives an agent the findings.Publishing for agents:
llms.txt and llms-full.txt. Hidden versions are left out.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. Upgrade a Nimbus site walks through one.
Pull requests are welcome; for anything bigger than a small fix, start with an issue or a discussion. See CONTRIBUTING.md, and CLAUDE.md for the architecture and agent context.