Repolode
cloudflare

cloudflare/nimbus

A scaffolder that generates an editable Astro documentation site into your repo, with agent-readable Markdown and llms.txt output built in.

Stars
1,431
Forks
52
Open issues
9
Last commit
4 hours ago

What is it?

Nimbus scaffolds a complete Astro documentation site into your repository as real source files for layouts, components, styles, routes and content. The underlying plumbing ships as an npm package, while everything you see and modify lives in your own codebase from the first commit.

It is built for both human readers and coding agents. Every discoverable page is available as clean Markdown and as MDX source, and the site publishes /llms.txt, /llms-full.txt, JSON-LD, a sitemap and per-page OG images. Full-text search, light and dark themes, breadcrumbs, pagination and versioned docs are included, along with linting for prose and MDX.

The default output is static and can be hosted anywhere. Cloudflare is the first-class target, with a server-rendered output mode and a wrangler.jsonc in the default scaffold. Optional components and agent-handoff recipes can be added from a registry. The project is pre-1.0 and its public surface may change between minor releases.

Key features

  • 01Scaffolds an Astro docs site with editable layouts, components, styles and content.
  • 02Publishes Markdown and MDX source versions of each page for agents.
  • 03Generates llms.txt, llms-full.txt, JSON-LD, sitemap and OG images.
  • 04Includes full-text search, light/dark theming and versioned docs.
  • 05Provides prose and MDX linting plus config validation.
  • 06Supports static output and Cloudflare server rendering.

Use cases

  • Building a product documentation site that you want to customize at the file level.
  • Publishing docs that coding agents can read as easily as browsers.
  • Hosting a versioned documentation site on Cloudflare.

Topics

FAQ

What is nimbus?
A scaffolder that generates an editable Astro documentation site into your repo, with agent-readable Markdown and llms.txt output built in. Nimbus scaffolds a complete Astro documentation site into your repository as real source files for layouts, components, styles, routes and content. The underlying plumbing ships as an npm package, while everything you see and modify lives in your own codebase from the first commit.
Is nimbus free to use? What license does it have?
nimbus is open source under the MIT license. Check the license terms before using it in commercial products.
Is nimbus still maintained?
Actively maintained. The last commit to nimbus was on Oct 19, 2026.
What can I use nimbus for?
Building a product documentation site that you want to customize at the file level. Publishing docs that coding agents can read as easily as browsers. Hosting a versioned documentation site on Cloudflare.
Where can I get nimbus?
The source code and installation instructions are on GitHub: https://github.com/cloudflare/nimbus

Summary generated by AI from the project's README. GitHub stats refresh daily.

Related projects