sourcey/sourcey

何を解決するか

Sourceyは、API仕様、ソースコードのコメント、Markdownガイドなど複数のドキュメント形式が分散している問題を解決し、1つの統合された静的HTMLサイトに統合します。複雑なツールチェーン（例：C++用のBreathe/Exhale/Sphinxパイプライン）や外部ホスティングサービスに依存する必要がなくなります。

動作方法

静的サイトジェネレータとして、ビルド時にさまざまなドキュメントソースを解析し、ポータブルなHTMLサイトにレンダリングします。sourcey.config.tsという設定ファイルを通じて複数の入力形式をサポートしており、以下が含まれます：

• API仕様：OpenAPI（2.0～3.2）およびMCPサーバーのドキュメント。
• ソースコード：Doxygen XML（C++）、ネイティブGoツールチェーン抽出（godoc）、夜間版rustdoc JSON（Rust）。
• ガイド：Markdownファイルおよび既存のMkDocs構造。

Viteを搭載した開発サーバーによりホットリロードをサポートし、Astroサイトに直接統合可能または任意のホストに静的ファイルとしてデプロイ可能です。

対象ユーザー

複雑なAPIやマルチランゲージのコードベースを持つソフトウェアプロジェクトのための、検索可能なプロフェッショナルなドキュメントを維持したい開発者や技術ライター向けです。

特徴

• 統合ビルド：1つのビルドプロセスでAPIリファレンス、ガイド、変更履歴、ロードマップを生成。
• LLM対応：AIモデル用のポータブルコンテキストを提供するため、自動的に llms.txt と llms-full.txt を生成。
• 広範な言語対応：GoとRustのドキュメントをネイティブサポート、C++はDoxygenで対応。
• 豊富なMarkdown：ステップ、カード、アコーディオンなどの組み込みコンポーネントでガイドを強化。
• ランタイムゼロ：ダッシュボードやAPI呼び出しを一切必要とせず、静的HTMLのみを出力。