DoDocs
Você entrega ao DoDocs uma pasta de arquivos .md/.mdx. Ele devolve um site estático completo,
com navegação lateral, busca, sumário, destaque de sintaxe, temas claro e escuro, e links de
anterior e próximo. Você não escreve nenhuma linha de código de aplicação.
Nesta página
- O problema que o DoDocs resolve
- Como a estrutura de pastas vira o site
- Por onde começar
O problema
Documentação boa morre por atrito. Se publicar exige configurar um site, instalar um framework e manter um build, a documentação fica desatualizada, ou nem chega a existir.
O DoDocs tira esse atrito do caminho. A documentação continua sendo Markdown puro, versionada no mesmo repositório do código, no mesmo commit da mudança que ela descreve. Publicar é adicionar uma GitHub Action e apontá-la para a pasta.
A estrutura de pastas define o site
Não existe arquivo de rotas nem índice para manter. Pastas viram seções da barra lateral e arquivos viram páginas:
docs/
├── getting-started/
│ ├── introduction.md
│ └── configuration.md
└── writing/
└── markdown.md
Essa árvore é exatamente a barra lateral. Criar um arquivo cria uma página. Mover um arquivo move a página. Nada mais precisa ser tocado.
A ordem, os agrupamentos e os nomes exibidos podem ser ajustados quando o padrão não serve, mas são
ajustes opcionais, não obrigações. Veja nav_order e nav_labels.
Por onde começar
- Configuração: as opções que você passa para a Action.
- GitHub Actions: publicar no GitHub Pages.
- Escrevendo: frontmatter, componentes e o que o Markdown aceita aqui.
Sobre este projeto
O DoDocs nasceu de um fork do pmndrs/docs, o gerador de documentação do Poimandres, e hoje é um projeto independente. O código original é licenciado sob MIT, e a licença e o copyright estão preservados no repositório.
O que mudou em relação ao original:
- Barra lateral que funciona para qualquer projeto. Navegação recursiva em qualquer profundidade, com ordenação, agrupamento por rótulo e nomes de exibição configuráveis. Uma pasta sem página própria leva o leitor para a primeira página dentro dela, em vez de dar 404.
- Interface em português ou inglês. O conteúdo nunca é traduzido, apenas a interface do site.
- Sem a bagagem do ecossistema original. Saíram o servidor MCP, o índice das bibliotecas do Poimandres e os sandboxes React, que só serviam ao projeto de origem. O DoDocs é um gerador de documentação, e nada além disso.
- Mais simples de operar. Uma imagem Docker publicada e um workflow reutilizável. Quem consome não instala nada, nem compila o gerador.
DoDocs v3.7.0 · Desenvolvido por @thiagocajadev · Baseado no trabalho de pmndrs/docs · Poimandres.