Início rápido

Instale o Blume, crie a estrutura de um novo projeto e publique sua primeira página de documentação em minutos — depois faça-a crescer até virar um site completo no seu próprio ritmo.

Passe de uma pasta vazia a um site de documentação funcionando com apenas alguns comandos. O Blume precisa do Node.js 22.19 ou superior e de uma pasta docs/ com pelo menos um arquivo .md ou .mdx — não há mais nada para configurar.

Instalar e executar

Create a project

O blume init faz algumas perguntas — onde criar o projeto, qual o nome do seu site de documentação, que modelo usar e onde fica o seu conteúdo — e depois gera a estrutura mínima: uma pasta de conteúdo, um arquivo de configuração e um package.json com os scripts dev, build e doctor, além de um .gitignore que deixa node_modules/, o .blume/ gerado, dist/ e .env.local (onde ficam os segredos locais) fora do controle de versão. Ele instala as dependências com o gerenciador de pacotes que o executou. Passe --yes para pular as perguntas e aceitar os padrões, ou --no-install para apenas criar os arquivos.

npx blume init

pnpm dlx blume init

yarn dlx blume init

bunx blume init

nubx blume init

aube dlx blume init

No pnpm 12, adicione --allow-build=esbuild depois de pnpm dlx (pnpm dlx --allow-build=esbuild blume init): o pnpm 12 se recusa a executar o script de instalação do esbuild, do qual o Astro depende, a menos que você o aprove. Dentro de um workspace pnpm já existente, a nova pasta precisa estar listada em packages do workspace (o pnpm não instala nada fora disso, então o init pula a instalação até que ela esteja listada), e o esbuild precisa de allowBuilds: { esbuild: true } no pnpm-workspace.yaml do workspace; o init lembra você das duas coisas. Com o Yarn 2 ou posterior, o init cria um .yarnrc.yml que muda o Yarn para uma instalação com node_modules, que é o que o Blume precisa; no Yarn 1, execute npx blume init.

docs/
  index.mdx
.gitignore
blume.config.ts
package.json

Start the dev server

No diretório do projeto, o Blume gera o runtime e serve a sua documentação com recarregamento automático.

npm run dev

pnpm run dev

yarn run dev

bun run dev

nub run dev

aube run dev

Build for production

O HTML estático é gerado em dist/, com um índice de pesquisa local construído sobre ele.

npm run build

pnpm run build

yarn run build

bun run build

nub run build

aube run build

Vai adicionar o Blume a um projeto que já tem um package.json? O blume init não mexe nos arquivos existentes e pula a instalação, então instale o Blume você mesmo (npm install blume) e depois adicione "dev": "blume dev" e "build": "blume build" aos scripts dele, ou execute npx blume dev diretamente. Os próximos passos que o init exibe incluem os dois comandos para o seu gerenciador de pacotes.

Escrever a sua primeira página

Cada página é Markdown ou MDX com um pouco de frontmatter — o title e a description são exibidos automaticamente como o cabeçalho e a introdução da página. Coloque isso em 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.
:::

Salve o arquivo e o servidor de desenvolvimento recarrega na hora. A navegação, a pesquisa e os metadados das páginas são inferidos a partir dos seus arquivos à medida que você os adiciona — continue escrevendo, que o site acompanha.

Próximos passos

Configuration

Ajuste o título, o tema, a pesquisa e a implantação.

Components

Explore a biblioteca de componentes integrada.

Discoverability

Publique um llms.txt, cartões sociais e um servidor MCP.

Deployment

Coloque no ar em qualquer hospedagem estática.