sourcey/sourcey

何を解決するか

Sourceyは、API仕様、ソースコードのコメント、Markdownガイドなど複数の形式の技術文書が分散している問題を解決します。OpenAPI、MCP、Doxygen XML、godoc、rustdoc、Markdownといったさまざまな入力形式を統合し、1つの統合された静的HTMLサイトにまとめます。C++向けのBreathe/Exhale/Sphinx連鎖のような複雑なパイプラインを必要とせず、pkg.go.devのような言語固有のドキュメントを外部ホスティングに依存する必要もありません。

動作方法

ビルド時生成ツールとして、OpenAPI、MCP、Doxygen XML、godoc、rustdoc、Markdownなどのさまざまな入力を解析し、静的HTMLにレンダリングします。サイト構造とナビゲーションを定義するTypeScriptベースの構成ファイル（sourcey.config.ts）を使用します。CLIとして実行可能で、Astroサイトに統合可能、または開発中のホットリロードを実現するVite開発サーバーでも利用できます。

対象ユーザー

マルチランゲージのコードベースや複雑なAPI仕様を持つソフトウェアプロジェクトの包括的なドキュメントを維持する必要がある開発者や技術ライター向けです。ランタイム依存性を持たず、静的出力を自ら管理したい方におすすめです。

特徴

• マルチソース対応: OpenAPI（2.0～3.2）、MCPサーバードキュメント、Doxygen（C++）、godoc（Go）、rustdoc（Rust）を統合。
• LLM対応: AIモデル用のポータブルコンテキストを提供するため、自動的に llms.txt と llms-full.txt ファイルを生成。
• 豊富なMarkdown: ステップ、カード、アコーディオンなどのカスタムコンポーネントを標準のMarkdownファイル内で使用可能。
• 静的出力: フレームワークフリーのHTMLを出力でき、GitHub Pages、Vercel、S3などあらゆる静的ホスティングにデプロイ可能。
• 柔軟なテーマ: デフォルト、ミニマル、APIファースト、リーダーなど複数のレイアウトオプションを提供。色やフォントもカスタマイズ可能。