Installation | Nimbus

One command sets up a project with layouts, components, content schemas, search, sitemap, OG images, and a Markdown version of every page.

Requirements

Node 22.12 or later
A package manager — npm, pnpm, yarn, or bun
Git — for edit links and last-updated dates

Scaffold

npx @cloudflare/create-nimbus-docs@latest

Pick a directory name, then choose your preferences:

Template

Two choices — full (core components, demo content, populated theme tokens) or empty (the minimum to run, ready for your own content).

Output mode

Static prerenders every content collection route and deploys anywhere. Server uses Cloudflare to render those routes on request. You can override individual collections later.

Target

Static output supports Cloudflare or another static host. Interactive server setup currently offers Cloudflare Workers; explicit --adapter flags also support Vercel, Netlify, and Node.

Install dependencies

The scaffolder runs your package manager automatically. Skip if you want to edit package.json first.

What lands in your repo

my-docs/
- src/
  - components/
    - ui/
  - content/
    - docs/
  - pages/
  - styles/
    - globals.css
  - components.ts
- astro.config.ts
- package.json

The nimbus-docs npm package ships the invisible plumbing (integration, data helpers, schemas). Everything visible — components under src/components/, MDX content under src/content/docs/, routes under src/pages/, design tokens in src/styles/globals.css, and the MDX globals registry at src/components.ts — copies into your repo and is yours to edit.

Run

npm run dev

yarn run dev

pnpm run dev

bun run dev

Then open the printed URL.

Build and deploy

npm run build

yarn run build

pnpm run build

bun run build

Static scaffolds emit dist/ for any static host. Cloudflare server scaffolds request-render canonical content collection routes and include the appropriate wrangler.jsonc and a deploy script.