Repolode
Предложить
ioteverythin

ioteverythin/OpenDocs

Python CLI, который преобразует README из GitHub, Markdown-файлы и Jupyter Notebook в Word, PDF, PPTX, блог, LaTeX и другие форматы документации.

Открыть на GitHub
Звёзды
235
Форки
19
Открытые issues
0
Последний коммит
2 месяца назад

Что это?

OpenDocs принимает URL репозитория GitHub, локальный Markdown-файл или Jupyter Notebook (.ipynb) и создает структурированную документацию в таких форматах, как Word (.docx), PowerPoint (.pptx), PDF, SEO-оптимизированные посты для блога, задачи Jira в формате JSON, списки изменений, статьи в LaTeX в стиле IEEE, FAQ и архитектурные диаграммы. Базовый режим работает только с разбором Markdown, без LLM, а дополнительный режим с LLM поддерживает извлечение сущностей, построение графа знаний и подготовку сводок для заинтересованных сторон.

Помимо генерации документов, OpenDocs включает интерактивный HTML-граф знаний, экспорт в queryable-файл graph.json, Markdown-вики в стиле Wikipedia и 25 встроенных тем. Также доступны команды для сравнения двух версий документации, проверки документации линтером в CI, оценки ее охвата относительно API проекта и отслеживания изменений в файлах с возможностью автоматически создавать pull request. Поддерживаются LLM-провайдеры OpenAI, Anthropic, Google Gemini, Ollama и Azure OpenAI.

Ключевые возможности

  • 01Преобразует README из GitHub, Markdown-файлы и блокноты .ipynb в документы Word, PDF, PPTX, посты для блога и LaTeX.
  • 02Создает интерактивный HTML-граф знаний с кластеризацией сообществ и метками происхождения данных.
  • 03Экспортирует граф в graph.json, по которому можно выполнять запросы офлайн с помощью команды query.
  • 04Предоставляет команды lint, diff и coverage для проверки документации в CI.
  • 05Включает наблюдатель за файлами, который обновляет документацию при изменениях и может создавать pull request через gh.
  • 06Поддерживает пять LLM-провайдеров и работу офлайн с кэшированием в качестве дополнительного режима.

Сценарии использования

  • Преобразование README проекта в отчет Word или презентацию для заинтересованных сторон.
  • Создание документации по исследовательским или дата-сайентистским блокнотам Jupyter.
  • Проверка качества документации и охвата API в CI-пайплайне.
  • Автоматическое обновление документации с помощью cron-задачи, которая создает pull request.

Темы

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

Частые вопросы

Что такое OpenDocs?
Python CLI, который преобразует README из GitHub, Markdown-файлы и Jupyter Notebook в Word, PDF, PPTX, блог, LaTeX и другие форматы документации. OpenDocs принимает URL репозитория GitHub, локальный Markdown-файл или Jupyter Notebook (.ipynb) и создает структурированную документацию в таких форматах, как Word (.docx), PowerPoint (.pptx), PDF, SEO-оптимизированные посты для блога, задачи Jira в формате JSON, списки изменений, статьи в LaTeX в стиле IEEE, FAQ и архитектурные диаграммы. Базовый режим работает только с разбором Markdown, без LLM, а дополнительный режим с LLM поддерживает извлечение сущностей, построение графа знаний и подготовку сводок для заинтересованных сторон.
OpenDocs можно использовать бесплатно? Какая у него лицензия?
OpenDocs распространяется с открытым исходным кодом под лицензией MIT. Перед использованием в коммерческих продуктах проверьте условия лицензии.
OpenDocs всё ещё поддерживается?
Обновлялся за последние 6 месяцев. Последний коммит в OpenDocs — 16 авг. 2026 г..
Для чего можно использовать OpenDocs?
Преобразование README проекта в отчет Word или презентацию для заинтересованных сторон. Создание документации по исследовательским или дата-сайентистским блокнотам Jupyter. Проверка качества документации и охвата API в CI-пайплайне. Автоматическое обновление документации с помощью cron-задачи, которая создает pull request.
Где скачать OpenDocs?
Исходный код и инструкции по установке — на GitHub: https://github.com/ioteverythin/OpenDocs

Описание создано ИИ на основе README проекта. Статистика GitHub обновляется ежедневно.

Похожие проекты

anthropics / claude-code

Агентный инструмент для программирования, который работает в терминале, изучает кодовую базу и выполняет задачи по разработке, объясняет код и помогает с Git-процессами по запросам на естественном языке.

ИИ и машинное обучение#ai#coding-assistant#cli
152,2 тыс.27 тыс.TypeScriptБез лицензииОбновлён вчера