Docsbook
Visão geral

Transforme seu README.md em um verdadeiro site de documentação

A documentação do seu projeto está em README.md. Você sempre quis configurar um site de documentação de verdade. Você deu uma olhada no Docusaurus, abriu o guia de configuração e fechou a aba.

Este post é a alternativa de 5 segundos.

TL;DR#

  • A maioria dos projetos OSS publica a documentação apenas como README.md
  • Um README é suficiente, mas não é indexado no Google tão bem quanto um site de documentação de verdade, não tem chat de IA, análises nem traduções
  • O Docsbook transforma um README.md (e um docs/ opcional) em um site em docsbook.io/yourorg/yourrepo em 5 segundos
  • Publicar um repositório público não custa nada. Sem CI/CD nem arquivos de configuração.

Por que um README não é suficiente#

Três perdas para projetos que têm apenas um README:

1. SEO#

Um README do GitHub é indexado, mas o Google posiciona github.com/user/repo para o nome do repositório, não para consultas técnicas. Um usuário que pesquisa "como autenticar com a biblioteca X" raramente chega ao README, mesmo quando a resposta está lá.

Um site de documentação real em docs.yourproject.com (ou docsbook.io/yourorg/yourrepo) aparece nas pesquisas para as consultas de cauda longa que o seu README aborda, mas não consegue fazer aparecer.

2. Distribuição de IA#

O ChatGPT e o Perplexity citam READMEs do GitHub, mas de forma inconsistente. Um site de documentação limpo, com llms.txt, títulos estruturados e JSON-LD é citado com muito mais frequência.

Se o seu projeto depende da descoberta por desenvolvedores, as citações de IA agora são um canal real — consulte Como fazer com que a documentação seja citada pelo ChatGPT.

3. UX#

Um README de 1.500 linhas é uma única parede de rolagem. Um site de documentação oferece uma barra lateral, pesquisa, títulos como links âncora, breadcrumbs e botões para copiar código. O mesmo conteúdo, com uma capacidade de descoberta muito melhor.

Configuração em 5 segundos#

Três etapas:

  1. Acesse docsbook.io
  2. Entre com o GitHub
  3. Cole github.com/yourorg/yourrepo

Site disponível em docsbook.io/yourorg/yourrepo. Seu README aparece como a página inicial. Se você tiver uma pasta docs/, essas páginas se tornam a barra lateral.

Sem configuração. Sem docsbook.config.js. Sem pipeline de CI/CD. Sem implantação.

O que é indexado#

O Docsbook lê:

  • README.md na raiz do repositório → página inicial
  • pasta docs/ (recursivamente) → páginas do site
  • docs/README.md → página inicial da documentação
  • frontmatter YAML (title, description) → metadados da página

Se você tiver apenas um README, obterá um site de documentação de uma única página. Se tiver docs/getting-started.md, docs/api.md, etc., obterá um site com várias páginas e uma barra lateral criada a partir da estrutura de pastas.

Frontmatter (opcional)#

Adicione YAML no início de qualquer arquivo markdown:

---
title: "Quick Start"
description: "Get up and running in 60 seconds"
---
 
# Quick Start
...

title torna-se o título da página nos mecanismos de busca. description torna-se a meta descrição. Se você ignorar ambos, o Docsbook usará o primeiro H1 como título e o primeiro parágrafo como descrição.

Quanto custa publicar um projeto OSS?#

A publicação do site não custa nada, e o mesmo vale para quem o lê. O que é medido é o uso de IA: cada projeto tem seu próprio saldo, e as perguntas ao assistente e as execuções de tradução consomem esse saldo. Os valores atuais estão em docsbook.io/pricing, gerados a partir das constantes de preços atuais em cada solicitação.

Publicar um repositório oferece:

  • Qualquer repositório público do GitHub, renderizado como um site
  • Nome, ícone, logotipo e cores de destaque personalizados para os modos claro e escuro
  • Alternância de tema, pesquisa, breadcrumbs e botões para copiar código
  • Links no cabeçalho e links sociais (GitHub, Discord, X)
  • Análises — visualizações de página, páginas mais acessadas, referências e países
  • llms.txt e llms-full.txt para descoberta por IA
  • Um servidor MCP, para que o Claude Code e o Cursor possam ler e editar a documentação
  • Chat de IA baseado no seu README.md e docs/
  • docs.yourproject.com com SSL automático

A única coisa que você não pode desativar é o pequeno link "Powered by Docsbook" no rodapé da página. Ele é exibido em todos os sites Docsbook, sem exceção — essa é a contrapartida por não precisar executar a hospedagem por conta própria.

Como uso meu próprio domínio em vez de docsbook.io?#

Aponte um subdomínio para o Docsbook e ele disponibilizará sua documentação nesse endereço com SSL provisionado automaticamente.

  • Painel → Configurações → Domínio
  • DNS: CNAME docs → cname.vercel-dns.com
  • O SSL é automático

Guia completo, incluindo domínios raiz e redirecionamentos: Domínio personalizado para documentação.

O que acontece quando você faz push#

Você envia um commit para main. O Docsbook indexa a alteração e atualiza o site. Nenhuma GitHub Action, nenhuma etapa de build. O novo conteúdo fica disponível em segundos.

Perguntas comuns#

Funciona para repositórios privados?#

Sim. O Docsbook autentica-se por meio do seu escopo OAuth do GitHub, e o site publicado pode ser público ou privado.

E quanto ao MDX ou às demonstrações interativas?#

O Docsbook prioriza o Markdown. Para demonstrações interativas, hospede a demonstração em outro local e inclua um link para ela. Se o seu projeto precisar de componentes React incorporados às páginas da documentação, consulte Você deveria deixar de usar o Docusaurus em 2026? — o Docusaurus é mais adequado para isso.

Ele terá a aparência de qualquer outro site Docsbook?#

Você controla as cores da marca, as fontes, o layout, o cabeçalho, o rodapé, a barra lateral e seu próprio domínio. A única coisa que você não pode remover é o pequeno link "Powered by Docsbook" no rodapé — ele é exibido em todos os sites Docsbook.

Posso sair mais tarde?#

Sim. Seus arquivos estão no GitHub. Cancele a assinatura, aponte o DNS para outro lugar e seu conteúdo permanecerá intacto.

Cole github.com/yourorg/yourrepo e o site estará no ar em cinco segundos. Nada é copiado para fora do seu repositório, então o README continua sendo a fonte de verdade.

Comece gratuitamente — sem cartão de crédito

Próximos passos#

Updated

Esta página foi útil?

Desenvolvido por Docsbook