ioteverythin/OpenDocs

これは何？

主な機能

• 01GitHubのREADME、Markdown、.ipynb形式のNotebookをWord、PDF、PPTX、ブログ、LaTeXに変換します。
• 02コミュニティのクラスタリングと出典ラベルを備えた、インタラクティブなHTMLナレッジグラフを構築します。
• 03graph.jsonをエクスポートし、queryコマンドでオフライン検索できます。
• 04CIでドキュメントをチェックするためのlint、diff、coverageコマンドを提供します。
• 05ファイルの変更時にドキュメントを再生成する監視機能を備え、gh経由でプルリクエストを作成できます。
• 065つのLLMプロバイダーに対応し、オフラインでの利用やキャッシュを使った動作もオプションでサポートします。

ユースケース

• プロジェクトのREADMEを、ステークホルダー向けのWordレポートやスライド資料に変換する。
• 研究やデータサイエンスのJupyter Notebookからドキュメントを生成する。
• CIパイプラインでドキュメントの品質とAPIの網羅率をチェックする。
• 自動でプルリクエストを作成するcronジョブで、生成したドキュメントを最新の状態に保つ。

トピック

よくある質問

OpenDocs とは？

GitHubのREADME、Markdown、Jupyter NotebookをWord、PDF、PPTX、ブログ、LaTeXなどの形式に変換するPython CLI。 OpenDocsは、GitHubリポジトリのURL、ローカルのMarkdownファイル、またはJupyter Notebook（.ipynb）をもとに、Word（.docx）、PowerPoint（.pptx）、PDF、SEO対策済みのブログ記事、JSON形式のJiraチケット、変更履歴、IEEE形式のLaTeX論文、FAQ、アーキテクチャ図など、構造化されたドキュメントを生成します。基本モードではLLMを使わず、Markdownの解析だけで動作します。オプションのLLMモードでは、エンティティ抽出、ナレッジグラフ、ステークホルダー向けの要約を利用できます。

OpenDocs は無料で使えますか？ライセンスは？

OpenDocs は MIT ライセンスのオープンソースです。商用製品で使う前にライセンス条件を確認してください。

OpenDocs は今もメンテナンスされていますか？

半年以内に更新あり。OpenDocs の最終コミットは 2026年8月16日 です。

OpenDocs は何に使えますか？

プロジェクトのREADMEを、ステークホルダー向けのWordレポートやスライド資料に変換する。 研究やデータサイエンスのJupyter Notebookからドキュメントを生成する。 CIパイプラインでドキュメントの品質とAPIの網羅率をチェックする。 自動でプルリクエストを作成するcronジョブで、生成したドキュメントを最新の状態に保つ。

OpenDocs はどこで入手できますか？

ソースコードとインストール手順は GitHub にあります：https://github.com/ioteverythin/OpenDocs