Traga seus docs do GitBook para o OpenDocs
Sincronize seu espaço do GitBook com o GitHub e depois importe no OpenDocs. As páginas mantêm a ordem e a hierarquia, e você não precisa digitar nada de novo.
Cinco passos, nesta ordem
- Sincronize seu espaço do GitBook com o GitHub. No GitBook, ative o Git Sync e sincronize o espaço com um repositório do GitHub. O GitBook grava suas páginas como arquivos Markdown, com um arquivo
SUMMARY.mdque guarda o sumário. O Git Sync é um recurso do GitBook, então confirme que o seu plano do GitBook o inclui. - Crie um espaço no OpenDocs. Comece grátis: toda conta começa com 14 dias de Pro, sem cartão de crédito. Adicione um espaço vazio para os docs importados.
- Importe o repositório. Abra o espaço e escolha Import from GitBook (é assim que aparece no app). Cole o endereço do repositório (
owner/repofunciona) e, se o repositório for privado, um token do GitHub com o escoporepo. O token é usado uma única vez e não é armazenado. - Revise as páginas. Confira a ordem das páginas, as imagens e qualquer página que use blocos próprios do GitBook, como abas ou avisos. O importador converte Markdown padrão, então os blocos especiais são as páginas que mais vale a pena revisar.
- Publique. Compartilhe o endereço do OpenDocs ou coloque o espaço no seu próprio domínio (Pro). Mantenha seu site do GitBook no ar até ficar satisfeito.
O que é transferido e o que não é
| Item | Na importação |
|---|---|
| Conteúdo das páginas (Markdown) | Convertido em páginas do OpenDocs |
| Ordem das páginas e hierarquia pai/filho | Mantidas, a partir do sumário do SUMMARY.md |
| Front matter no início de um arquivo | Removido |
| Imagens | Vinculadas a partir do seu repositório do GitHub, então mantenha o repositório disponível |
| Status das páginas | As páginas importadas são publicadas imediatamente |
| Arquivos que não podem ser obtidos | Informados em uma lista, e o restante é importado normalmente |
| Usuários, comentários, análises e integrações | Não fazem parte do repositório, então configure-os no OpenDocs |
Teste sem arriscar seus docs no ar
A importação apenas lê o seu repositório. Nada muda no GitBook, então seus docs atuais continuam online enquanto você confere o resultado. Como as páginas importadas são publicadas na hora, importe primeiro para um espaço novo e compartilhe o link só quando estiver pronto.
O que você ganha depois da mudança
- Docs que o Claude e outras ferramentas de IA conseguem ler. Todo espaço publicado tem um servidor MCP integrado, um arquivo
llms.txte uma versão limpa em Markdown de cada página. - Traduções para 38 idiomas com o Claude, usando sua própria chave de API da Anthropic, mais o seu consumo da Anthropic.
- Sincronização bidirecional com o GitHub, para que seu repositório continue sendo a fonte da verdade.
- Um plano Grátis que continua grátis. Depois do teste Pro de 14 dias você segue no plano Grátis com 1 espaço, com seus docs publicados incluídos.
Quer comparar antes? Leia OpenDocs vs GitBook para ver a comparação lado a lado, inclusive os casos em que o GitBook é a melhor escolha.
Perguntas frequentes
Meu repositório precisa ser público?
Não. Um repositório público é importado sem token. Para um privado, use um token do GitHub com o escopo repo. Ele é usado uma única vez na importação e não é armazenado.
Meu repositório não tem SUMMARY.md. Ainda consigo importar?
O importador monta a árvore de páginas a partir do SUMMARY.md, que o GitBook cria ao sincronizar um espaço. Sem esse arquivo ele para e avisa você, então nunca fica uma importação pela metade.
Minhas imagens continuarão funcionando?
Sim, enquanto o repositório continuar disponível. As imagens são vinculadas a partir do GitHub, em vez de copiadas.
Posso importar de novo mais tarde?
Sim. Importe para um espaço novo sempre que quiser uma cópia nova.