Quickstart
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.
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
Install Blume
Add the package to a new or existing project.
npm install blumepnpm add blumeyarn add blumebun add blumeScaffold 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.
blume initdocs/
index.mdx
blume.config.tsStart the dev server
Blume generates the runtime and serves your docs with hot reload.
blume devBuild for production
Static HTML is written to dist/, with a local search index built over it.
blume buildWrite 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:
---
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.