---
title: Quickstart
description: Install Blume, scaffold a new project, and ship your first documentation page in minutes — then grow it into a full site at your own pace.
sidebar:
  label: Quickstart
  order: 1
---

Go from an empty folder to a running docs site in a few commands. Blume needs **Node.js 22.12 or newer** and a `docs/` folder with at least one `.md` or `.mdx` file — there's nothing else to set up.

## Install and run

<Steps>
  <Step title="Install Blume">
    Add the package to a new or existing project.

    ```package-install
    npm i blume
    ```

  </Step>
  <Step title="Scaffold a project">
    `blume init` asks a few questions — where to create the project, what your
    docs site is called, which template, and where your content lives — then
    scaffolds the minimum surface: a content folder and a config file. Pass
    `--yes` to skip the prompts and take the defaults.

    ```bash
    blume init
    ```

    ```txt
    docs/
      index.mdx
    blume.config.ts
    ```

  </Step>
  <Step title="Start the dev server">
    Blume generates the runtime and serves your docs with hot reload.

    ```bash
    blume dev
    ```

  </Step>
  <Step title="Build for production">
    Static HTML is written to `dist/`, with a local search index built over it.

    ```bash
    blume build
    ```

  </Step>
</Steps>

:::tip
Blume works with any package manager and never requires you to set up Astro or Tailwind yourself.
:::

## Write your first page

Every page is Markdown or MDX with a little frontmatter — the `title` and `description` render as the page heading and intro automatically. Drop this into `docs/index.mdx`:

```mdx docs/index.mdx lineNumbers
---
title: Introduction
description: Welcome to my docs.
---

Welcome! Use **Markdown** and built-in components — no imports required:

:::note
Blume ships callouts, cards, tabs, steps, and more.
:::
```

Save it, and the dev server reloads instantly. Navigation, search, and page metadata are inferred from your files as you add them — keep writing, and the site keeps up.

## Next steps

<CardGroup cols={2}>
  <Card title="Configuration" href="/docs/configuration" icon="file">
    Tune the title, theme, search, and deployment.
  </Card>
  <Card title="Components" href="/docs/content/components" icon="folder">
    Explore the built-in component library.
  </Card>
  <Card title="AI" href="/docs/configuration/ai" icon="lightbulb">
    Ship `llms.txt` and an Ask AI assistant.
  </Card>
  <Card title="Deployment" href="/docs/deployment" icon="rocket">
    Go live on any static host.
  </Card>
</CardGroup>
