Converte documentos do Office, PDFs, EPUB e CSV em Markdown compatível com GitHub usando bindings para Rust, Node.js, Python e WASM.
ioteverythin/OpenDocs
CLI em Python que converte READMEs do GitHub, arquivos Markdown e notebooks Jupyter em Word, PDF, PPTX, posts de blog, LaTeX e outros formatos de documentação.
- Estrelas
- 235
- Forks
- 19
- Issues abertas
- 0
- Último commit
- há 2 meses
O que é?
O OpenDocs recebe a URL de um repositório do GitHub, um arquivo Markdown local ou um Jupyter Notebook (.ipynb) e gera documentação estruturada em formatos como Word (.docx), PowerPoint (.pptx), PDF, posts de blog otimizados para SEO, tickets do Jira em JSON, changelogs, artigos em LaTeX no estilo IEEE, FAQs e diagramas de arquitetura. O modo básico funciona apenas com análise de Markdown, sem LLM, enquanto o modo opcional com LLM adiciona extração de entidades, um grafo de conhecimento e resumos para stakeholders.
Além de gerar documentos, a ferramenta inclui um grafo de conhecimento interativo em HTML, uma exportação queryable em graph.json, uma wiki em Markdown no estilo da Wikipédia e 25 temas integrados. Também oferece comandos para comparar duas versões da documentação, verificar a documentação com lint no CI, medir a cobertura da documentação em relação à superfície da API do código e monitorar alterações nos arquivos, com opção de abrir pull requests automaticamente. Os provedores de LLM compatíveis incluem OpenAI, Anthropic, Google Gemini, Ollama e Azure OpenAI.
Recursos principais
- 01Converte READMEs do GitHub, arquivos Markdown e notebooks .ipynb em documentos Word, PDF, PPTX, posts de blog e LaTeX.
- 02Cria um grafo de conhecimento interativo em HTML com agrupamento por comunidades e rótulos de proveniência.
- 03Exporta um graph.json que pode ser consultado offline com o comando query.
- 04Oferece comandos de lint, diff e coverage para verificar a documentação no CI.
- 05Inclui um monitor de arquivos que regenera a documentação quando há alterações e pode abrir pull requests via gh.
- 06É compatível com cinco provedores de LLM e oferece operação offline opcional com cache.
Casos de uso
- Transformar o README de um projeto em um relatório Word ou uma apresentação para stakeholders.
- Gerar documentação a partir de notebooks Jupyter de pesquisa ou ciência de dados.
- Verificar a qualidade da documentação e a cobertura da API em um pipeline de CI.
- Manter a documentação gerada atualizada com um cron job que abre pull requests automaticamente.
Tópicos
Perguntas frequentes
- O que é OpenDocs?
- CLI em Python que converte READMEs do GitHub, arquivos Markdown e notebooks Jupyter em Word, PDF, PPTX, posts de blog, LaTeX e outros formatos de documentação. O OpenDocs recebe a URL de um repositório do GitHub, um arquivo Markdown local ou um Jupyter Notebook (.ipynb) e gera documentação estruturada em formatos como Word (.docx), PowerPoint (.pptx), PDF, posts de blog otimizados para SEO, tickets do Jira em JSON, changelogs, artigos em LaTeX no estilo IEEE, FAQs e diagramas de arquitetura. O modo básico funciona apenas com análise de Markdown, sem LLM, enquanto o modo opcional com LLM adiciona extração de entidades, um grafo de conhecimento e resumos para stakeholders.
- OpenDocs é gratuito? Qual é a licença?
- OpenDocs é open source sob a licença MIT. Confira os termos da licença antes de usá-lo em produtos comerciais.
- OpenDocs ainda é mantido?
- Atualizado nos últimos 6 meses. O último commit de OpenDocs foi em 16 de ago. de 2026.
- Para que posso usar OpenDocs?
- Transformar o README de um projeto em um relatório Word ou uma apresentação para stakeholders. Gerar documentação a partir de notebooks Jupyter de pesquisa ou ciência de dados. Verificar a qualidade da documentação e a cobertura da API em um pipeline de CI. Manter a documentação gerada atualizada com um cron job que abre pull requests automaticamente.
- Onde consigo OpenDocs?
- O código-fonte e as instruções de instalação estão no GitHub: https://github.com/ioteverythin/OpenDocs
Resumo gerado por IA a partir do README do projeto. As estatísticas do GitHub são atualizadas diariamente.
Projetos relacionados
Um grafo local de conhecimento do código que fornece às ferramentas de programação com IA contexto preciso para revisões via MCP e CLI.
Uma ferramenta de programação com agentes que roda no terminal, lê sua base de código e executa tarefas de programação, explica código e gerencia fluxos de trabalho do git por meio de linguagem natural.
Agente de programação com IA e código aberto que lê seu projeto, edita arquivos e executa comandos e testes pelo terminal, desktop, navegador ou editor.
Biblioteca Rust e CLI que classifica PDFs como textuais ou digitalizados e extrai Markdown limpo, sem OCR por padrão.
Framework de pipelines de dados incremental em Python, com núcleo em Rust, que mantém índices vetoriais e grafos de conhecimento de agentes de IA sincronizados com fontes em constante mudança.