Início rápido: publique um site de documentação com o Docsbook
O que você aprenderá: como transformar uma única fonte — um repositório do GitHub, um site ou uma descrição do seu produto — em um site de documentação do Docsbook publicado, com uma URL pública, um índice de pesquisa e análises.
Antes de começar#
Você precisa de todos os itens a seguir:
- Uma versão atual do Chrome, Firefox, Safari ou Edge.
- Uma fonte, e apenas uma: um repositório do GitHub contendo pelo menos um arquivo
.md, uma URL de site público ou duas frases descrevendo o que você vende. - Uma forma de fazer login na etapa 3: uma conta do GitHub, uma conta do Google, um ID Apple ou um endereço de e-mail em que você possa receber um código de uso único.
Você não precisa de um cartão de crédito, de um pipeline de build nem de uma conta antes da etapa 3.
- Abra docsbook.io/start.
- Cole sua fonte no campo único: uma URL de site, um link de repositório do GitHub ou uma frase sobre seu produto. O Docsbook identifica qual é o tipo — não há nenhum tipo para escolher.
- Aguarde enquanto o Docsbook lê a fonte. Cada etapa informa o que foi lido e o que foi encontrado.
Resultado esperado: um site de rascunho é aberto em seu próprio painel de administração, com a contagem de páginas, a fonte de origem e todas as seções de marca, layout e SEO. Nenhuma conta foi criada ainda.
- Pressione Abrir no painel de administração ou clique na própria prévia.
- Navegue pelas páginas geradas como em um site de documentação real — cabeçalho, árvore da barra lateral, sumário, breadcrumbs e navegação anterior/próxima funcionam.
- Use o Assistente no painel para alterar a redação ou fazer perguntas sobre o site. Na caixa de mensagens, o modo interativo abre o site com o chat ao lado e cada bloco clicável.
Resultado esperado: você leu o rascunho e sabe se ele descreve corretamente seu produto. Um rascunho proveniente de um site ou de uma ideia permanece apenas no seu navegador até que você o publique.
- Pressione Publicar este site na página inicial do painel ou o botão azul na barra de ferramentas da própria documentação. Ele mostra Publicar se você ainda não alterou nada, Salvar alterações se você fez alterações e Reivindicar propriedade se você chegou por um link de reivindicação — os três fazem a mesma coisa.
- Escolha um método de login: GitHub, Google, Apple ou e-mail com um código de uso único.
- Conclua o processo de login.
Resultado esperado: o rascunho se torna um projeto Docsbook ativo, com um endereço público, um índice de pesquisa e análises. Nada do que você escreveu é refeito.
Se o site veio de um repositório do GitHub e você fez login com Google, Apple ou e-mail, o Docsbook também solicitará que você autorize o acesso ao GitHub — ele lê os arquivos do repositório por meio dessa autorização.
- Abra o endereço que o Docsbook exibe. Ele segue o padrão abaixo.
docsbook.io/{owner}/{repo}- Use a caixa de pesquisa no cabeçalho ou pressione Cmd+K (Ctrl+K no Windows e no Linux) e pesquise uma frase de uma das suas páginas.
Resultado esperado: a página é carregada em uma URL pública, a pesquisa retorna sua frase e o site pode ser lido sem fazer login.
O que você tem agora#
Você tem um site de documentação publicado: uma URL pública, pesquisa de texto completo, um sitemap.xml, llms.txt para agentes de IA e análises registrando visualizações de página desde o primeiro visitante. Um site criado a partir de um repositório do GitHub verifica novamente o repositório quando é visitado, portanto, fazer push para o GitHub atualiza as páginas sem uma etapa de build.
Próximos passos#
- Gerencie sua documentação — configurações, reindexação e quem tem permissão para ler o site
- Aponte seu próprio domínio para ele — um CNAME, SSL provisionado automaticamente
- Ative a tradução — publique as mesmas páginas em 15 idiomas
- Conecte um agente de IA via MCP — leia e edite a documentação pelo Claude Code ou Cursor
- Preços — o que é medido e pelo que o saldo de um projeto paga
Cole um repositório, a URL de um site ou uma frase sobre seu produto e leia o rascunho antes de entrar.