Repolode
Enviar
ioteverythin

ioteverythin/OpenDocs

CLI de Python que convierte README de GitHub, archivos Markdown y notebooks de Jupyter en Word, PDF, PPTX, blogs, LaTeX y otros formatos de documentación.

Ver en GitHub
Estrellas
235
Forks
19
Issues abiertos
0
Último commit
hace 2 meses

¿Qué es?

OpenDocs recibe la URL de un repositorio de GitHub, un archivo Markdown local o un Jupyter Notebook (.ipynb) y genera documentación estructurada en formatos como Word (.docx), PowerPoint (.pptx), PDF, publicaciones de blog optimizadas para SEO, tickets de Jira en JSON, registros de cambios, artículos en LaTeX con estilo IEEE, preguntas frecuentes y diagramas de arquitectura. El modo básico funciona únicamente a partir del análisis de Markdown, sin LLM, mientras que el modo LLM opcional añade extracción de entidades, un grafo de conocimiento y resúmenes para las partes interesadas.

Además de generar documentos, incluye un grafo de conocimiento HTML interactivo, una exportación graph.json consultable, una wiki Markdown al estilo de Wikipedia y 25 temas integrados. También ofrece comandos para comparar dos versiones de la documentación, analizarla con lint en CI, medir su cobertura frente a la superficie de API del código y vigilar cambios en los archivos con la opción de crear pull requests automáticamente. Entre los proveedores de LLM compatibles están OpenAI, Anthropic, Google Gemini, Ollama y Azure OpenAI.

Funciones clave

  • 01Convierte README de GitHub, archivos Markdown y notebooks .ipynb en documentos Word, PDF, PPTX, publicaciones de blog y archivos LaTeX.
  • 02Crea un grafo de conocimiento HTML interactivo con agrupación de comunidades y etiquetas de procedencia.
  • 03Exporta un archivo graph.json que se puede consultar sin conexión con el comando query.
  • 04Incluye comandos de lint, diff y coverage para revisar la documentación en CI.
  • 05Incluye un monitor de archivos que regenera la documentación cuando detecta cambios y puede abrir pull requests mediante gh.
  • 06Es compatible con cinco proveedores de LLM y permite trabajar sin conexión y con caché de forma opcional.

Casos de uso

  • Convertir el README de un proyecto en un informe de Word o una presentación para las partes interesadas.
  • Generar documentación a partir de notebooks de Jupyter de investigación o ciencia de datos.
  • Revisar la calidad de la documentación y la cobertura de API en un pipeline de CI.
  • Mantener actualizada la documentación generada mediante una tarea cron que abre pull requests automáticamente.

Temas

#documentation#markdown#jupyter-notebook#knowledge-graph#llm#cli#docx-generation#pdf

Preguntas frecuentes

¿Qué es OpenDocs?
CLI de Python que convierte README de GitHub, archivos Markdown y notebooks de Jupyter en Word, PDF, PPTX, blogs, LaTeX y otros formatos de documentación. OpenDocs recibe la URL de un repositorio de GitHub, un archivo Markdown local o un Jupyter Notebook (.ipynb) y genera documentación estructurada en formatos como Word (.docx), PowerPoint (.pptx), PDF, publicaciones de blog optimizadas para SEO, tickets de Jira en JSON, registros de cambios, artículos en LaTeX con estilo IEEE, preguntas frecuentes y diagramas de arquitectura. El modo básico funciona únicamente a partir del análisis de Markdown, sin LLM, mientras que el modo LLM opcional añade extracción de entidades, un grafo de conocimiento y resúmenes para las partes interesadas.
¿OpenDocs es gratuito? ¿Qué licencia tiene?
OpenDocs es open source bajo la licencia MIT. Revisa los términos de la licencia antes de usarlo en productos comerciales.
¿OpenDocs sigue mantenido?
Actualizado en los últimos 6 meses. El último commit de OpenDocs fue el 16 ago 2026.
¿Para qué puedo usar OpenDocs?
Convertir el README de un proyecto en un informe de Word o una presentación para las partes interesadas. Generar documentación a partir de notebooks de Jupyter de investigación o ciencia de datos. Revisar la calidad de la documentación y la cobertura de API en un pipeline de CI. Mantener actualizada la documentación generada mediante una tarea cron que abre pull requests automáticamente.
¿Dónde consigo OpenDocs?
El código fuente y las instrucciones de instalación están en GitHub: https://github.com/ioteverythin/OpenDocs

Resumen generado por IA a partir del README del proyecto. Las estadísticas de GitHub se actualizan a diario.

Proyectos relacionados