---
title: "Installation"
description: "Scaffold a Nimbus site in one command — Cloudflare, Vercel, Netlify, or static."
---

> Documentation Index
> Fetch the complete documentation index at: https://nimbus-docs.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Installation

import { FileTree } from "@/components/ui/file-tree";

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

```sh
npm install nimbus-docs
pnpm add nimbus-docs
yarn add nimbus-docs
bun add nimbus-docs
```

Pick a directory name, then choose your preferences:

1. **Template**

   Two choices — **full** (core components, demo content, populated theme tokens) or **empty** (the minimum to run, ready for your own content).
2. **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.
3. **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

```sh
npm run dev
pnpm dev
yarn dev
bun run dev
```

Then open the printed URL.

## Build and deploy

```sh
npm run dev
pnpm dev
yarn dev
bun run dev
```

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.

> **Tip**
>
> After scaffolding, run `nimbus-docs add <slug>` to install components from the registry. See the [CLI](/cli) page for the full list.

Source: https://nimbus-docs.com/undefined