Installation | Nimbus

One command sets up a project with layouts, components, content schemas, search, sitemap, OG images, and a markdown alternate for every page.

Requirements

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

Scaffold

npm create nimbus-docs

yarn create nimbus-docs

pnpm create nimbus-docs

bun create nimbus-docs

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).

Deploy target

Cloudflare ships with wrangler.jsonc pre-wired. Vercel, Netlify, and “Static” produce the same Astro static output — pick the one that matches your host.

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.mjs
- 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

The output is a regular Astro static build. Deploy dist/ to any host. Cloudflare scaffolds include the right wrangler.jsonc so wrangler deploy works without further setup.