Início rápido
Instale o Blume, crie a estrutura de um novo projeto e publique a sua primeira página de documentação em minutos — depois faça-a crescer até um site completo ao seu próprio ritmo.
Passe de uma pasta vazia a um site de documentação em funcionamento com apenas alguns comandos. O Blume precisa de Node.js 22.12 ou superior e de uma pasta docs/ com pelo menos um ficheiro .md ou .mdx — não há mais nada para configurar.
Instalar e executar
Install Blume
Adicione o pacote a um projeto novo ou já existente.
npm install blumepnpm add blumeyarn add blumebun add blumeScaffold 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 reside o seu conteúdo — e
depois gera a estrutura mínima: uma pasta de conteúdo e um ficheiro de
configuração. Passe --yes para saltar as perguntas e aceitar as predefinições.
blume initdocs/
index.mdx
blume.config.tsStart the dev server
O Blume gera o runtime e serve a sua documentação com recarregamento automático.
blume devBuild for production
O HTML estático é escrito em dist/, com um índice de pesquisa local construído sobre ele.
blume buildEscrever a sua primeira página
Cada página é Markdown ou MDX com um pouco de frontmatter — o title e a description são apresentados automaticamente como o cabeçalho e a introdução da página. Coloque isto 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.
:::Guarde o ficheiro e o servidor de desenvolvimento recarrega de imediato. A navegação, a pesquisa e os metadados das páginas são inferidos a partir dos seus ficheiros à medida que os adiciona — continue a escrever, que o site acompanha.