---
title: "Quickstart"
description: "Run a Nimbus docs site on your machine in five minutes."
---

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

# Quickstart

By the end you'll have a docs site running locally, with a page you've edited.

## Prerequisites

- Node 22.12 or later (`node --version`)

## Steps

1. **Create the site**

   ```sh
   npm create @cloudflare/nimbus-docs@latest -- my-docs --yes
   yarn create @cloudflare/nimbus-docs my-docs --yes
   pnpm create @cloudflare/nimbus-docs@latest my-docs --yes
   bun create @cloudflare/nimbus-docs@latest my-docs --yes
   ```
2. **Start the dev server**

   ```sh
   cd my-docs
   ```

   ```sh
   npm run dev
   yarn run dev
   pnpm run dev
   bun run dev
   ```
3. **Edit the home page**

   Open `src/content/docs/index.mdx`, change the title, and save.

## You should see

```text
 astro  v<version> ready in <n> ms
┃ Local    http://localhost:4321/
┃ Network  use --host to expose
```

Open `http://localhost:4321/`: your site, with your new title and a sidebar. The scaffolder wrote the layouts, components and styles into `my-docs/`, and they're yours to change.

[Search](/navigation/search) reads an index the build writes, so it answers once you run `npm run build`, then `npm run preview`.

## Next step

[Pages and routing](/writing/pages-and-routing): add your first real page.

Also: [Deploy to Cloudflare](/deploy/cloudflare) · [Project structure](/project-structure)

Source: https://nimbus-docs.com/quickstart/index.mdx