Blume 2.0

Blume 2.0

Hayden Bleasel · Escrita · Programação

Blume 2.0 é um framework de documentação open source que transforma uma pasta de Markdown em um site Astro rápido, com busca local, referências de API e servidor MCP para agentes.

Prévia da interface de Blume 2.0

Sobre Blume 2.0

About

O que é o Blume 2.0

Blume 2.0 é um framework de documentação construído sobre Astro e Vite. Você joga arquivos Markdown ou MDX em uma pasta docs/, roda um comando e recebe um site com navegação, busca, destaque de sintaxe e imagens Open Graph já configurados. Não existe código de aplicação para manter nem painel para abrir toda manhã.

A versão 2 mexe principalmente na configuração. Busca, deploy, fontes de conteúdo, referências de API, analytics e o backend do assistente viraram adaptadores importados de subcaminhos blume/* e chamados dentro de blume.config.ts. As configurações legíveis por máquina saíram de ai para uma chave agents. As páginas não mudam, então atualizar é trabalho de configuração, não de reescrita.

O que separa o Blume de outros geradores é o segundo público. Todo site publica llms.txt, uma versão em Markdown de cada página, uma API JSON somente leitura e um servidor MCP opcional, então um agente lê o mesmo que uma pessoa. Esse conjunto transforma um site de documentação em Markdown em documentação pronta para IA. O outro lado da moeda: é ferramenta de desenvolvedor, e quem espera um editor hospedado com prévia visual encontra um repositório Git.

Como começar

  1. Rode npx blume init em uma pasta vazia. A CLI instala as dependências e adiciona os scripts dev e build ao package.json.
  2. Abra blume.config.ts e defina o nome do site, a URL e os adaptadores de busca, deploy ou analytics que você precisar.
  3. Coloque os arquivos Markdown em docs/. A estrutura de pastas vira o caminho da URL e a ordem das páginas sai dos nomes de arquivo ou de um meta.ts.
  4. Inicie npm run dev para ver o resultado local e use npm run build para gerar a saída estática.
  5. Opcional: npx blume migrate <origem> --codex entrega um site Mintlify, Docusaurus, GitBook ou MkDocs para um agente de código fazer a conversão.

Informações do produto

Uma visão rápida dos preços, das plataformas compatíveis e do desempenho de Blume 2.0.

Plano gratuitoSim
Planos pagos$0 (MIT license)
PlataformaWeb, CLI (Node.js 22.19+)
DesenvolvedorHayden Bleasel
CategoriaEscrita · Programação
Data de lançamentoSep 2026
Última atualizaçãoOct 2026
Visitas ao site5.3K
Ranking global do site2.6M
Disponibilidade da APINão

Ideal para

Os usuários, tarefas e cenários em que esta ferramenta se encaixa melhor.

Usuários

  • Desenvolvedores que documentam o próprio produto
  • Times de plataforma e de API
  • Mantenedores de projetos open source

Tarefas

  • Publicar documentação técnica a partir de Markdown
  • Fazer agentes de código lerem a documentação
  • Migrar de outra plataforma

Cenários

  • Uma startup cresceu além do README
  • O produto sai em vários idiomas
  • O suporte responde às mesmas perguntas todo dia

Principais recursos

Páginas em Markdown com navegação deduzida

Pastas viram rotas e nomes de arquivo viram slugs, então uma página nova é um arquivo novo. A barra lateral se monta sozinha a partir da árvore de diretórios e depois aceita ajustes do frontmatter ou de um meta.ts ao lado das páginas. Dá para reordenar um grupo, colocar um ícone ou esconder uma página sem tocar no arquivo de configuração, e as migalhas de pão e o índice lateral acompanham a mesma estrutura.

Superfície para agentes com llms.txt e MCP

Cada site Blume publica llms.txt e uma versão .md por rota, o que deixa o agente baixar a origem da página em vez de raspar o HTML renderizado. O servidor MCP opcional expõe busca e leitura de páginas como ferramentas, e o site também serve uma API JSON de documentação descrita por um documento OpenAPI 3.1. Um manifesto em /.well-known/ai-catalog.json permite que registros de agentes encontrem o site.

Referências de API a partir do esquema

Blume funciona como gerador de referência de API para esquemas OpenAPI, AsyncAPI ou GraphQL, locais ou remotos. Você aponta a configuração para o arquivo e recebe a visão geral, uma página por operação, parâmetros, corpos de requisição e tabelas de resposta. Os exemplos de código saem em 18 linguagens, de cURL e Python a Go, Ruby e C#. Como a referência é construída no build, uma mudança de esquema aparece no próximo deploy.

Busca local e assistente na página

A busca funciona sem chave de API com um índice local, e acerta texto em chinês, japonês, coreano e tailandês, idiomas que não separam palavras com espaço. Sites maiores podem trocar por Algolia, Typesense, Orama Cloud, Mixedbread ou Pagefind via adaptador. O painel do assistente responde com as páginas do próprio site, com adaptadores para Vercel AI Gateway, OpenRouter, LLM Gateway, Inkeep ou qualquer endpoint compatível com OpenAI.

Tradução e documentação versionada

As pastas de locale produzem rotas com prefixo, navegação por idioma e textos de interface traduzidos, e blume translate preenche os idiomas que faltam. O versionamento congela uma pasta por release, adiciona um seletor de versão e mantém a busca limitada à versão escolhida. As duas funções chegam também à superfície para agentes, então o agente vê as mesmas rotas que o leitor.

Validação, auditoria e saída para Astro

blume validate confere links, âncoras e frontmatter antes do deploy. blume audit lê o HTML gerado e aponta problemas de SEO com o arquivo e a linha de origem. blume eval coloca um agente leitor e outro juiz contra a documentação para testar se as respostas são realmente encontráveis. Se o framework ficar pequeno, blume eject transforma o projeto oculto em um app Astro independente que passa a ser seu.

Prós e contras

Prós

  • A licença MIT cobre editores, páginas e tráfego sem limite, então o custo fica no hosting e nos tokens do modelo que você usar.
  • Começo sem configuração: `npx blume init` entrega um site com busca, navegação e imagens OG antes de você escrever qualquer config.
  • A superfície para agentes vem de fábrica, e não como remendo, o que economiza o trabalho de `llms.txt` e MCP que quase todo time de documentação precisa hoje.
  • Os adaptadores cobrem as escolhas chatas, de Algolia e Typesense a Vercel, Netlify, Cloudflare, PostHog e Plausible.
  • As checagens por CLI e o `eject` oferecem saída, então escolher o framework não vira armadilha.

Contras

  • O Blume 2.0 quebra a configuração anterior. Projetos que definiam busca, deploy, fontes ou assistente precisam reescrever esses blocos como chamadas de adaptador, e uma configuração grande toma uma tarde.
  • Não existe editor nem painel hospedado. Quem não usa Git depende de desenvolvedores ou de uma fonte CMS, e isso custa caro para times de marketing.
  • Exige Node.js 22.19 ou superior, então imagens de CI antigas falham até alguém atualizar o runtime.
  • Os recursos de IA são cobrados no provedor do modelo. O framework é grátis, mas um assistente com muito uso ou a narração criam um custo mensal variável.

Perguntas frequentes

Blume 2.0 é a segunda versão principal de um framework de documentação open source para Astro. Ele gera um site a partir de arquivos Markdown ou MDX e acrescenta busca, referências de API, tradução, versionamento e uma superfície que agentes conseguem ler.