haydenbleasel/blume

解決する課題

Blume は、Markdown または MDX ファイルのフォルダを本番対応のドキュメントサイトに変換できる、ゼロ設定のドキュメンテーションフレームワークです。アプリのボイラープレートを書いたり、複雑なフレームワーク設定を管理する必要がなくなり、さらに柔軟性も保たれ、完全な制御のためにスタンドアロンの Astro プロジェクトにイジェクトすることもできます。

仕組み

Blume CLI はコンテンツをグラフにスキャンし、.blume/ ディレクトリに隠し Astro プロジェクトを生成します。このプロジェクトは開発とビルドのために CLI によって駆動されます。Astro は、Blume の組み込みコンポーネントと生成データを利用するキャッチオールページを通じてサイトをレンダリングします。ユーザーはサイトを静的 HTML としてデプロイするか、AI アシスタントなどのリクエスト時機能のためにサーバーアダプターを使用できます。

対象ユーザー

フレームワークを管理する手間をかけずに、高速で AI 対応のドキュメントサイトを構築したい開発者やテクニカルライター。ただし、システムをカスタマイズしたり、スタンドアロンアプリに完全移行するオプションも必要とする人々向けです。

ハイライト

• AI 対応インフラストラクチャ：llms.txt と llms-full.txt ファイル、JSON ドキュメント API、コーディングエージェント向けのホスト型 MCP サーバー、オプションのページ内アシスタントを含みます。
• ゼロ設定セットアップ：スターターテンプレートのクローンやフレームワーク知識を必要とせず、ドキュメントフォルダをサイトに変換します。
• リッチなコンポーネントライブラリ：カード、タブ、アコーディオン、コードグループ、ライブコンポーネントプレビューをインポートなしで組み込みサポート。
• 拡張可能なコンテンツソース：ローカルファイルと、GitHub Releases、Notion、Sanity、Contentful などのリモートソースを混在させることができます。
• API リファレンス生成：OpenAPI、AsyncAPI、GraphQL 仕様をネイティブにリファレンスページとしてレンダリングします。
• エージェンティックツール：ローカルエージェントを使用してドキュメントをスキャフォールド、作成、翻訳するための CLI コマンドを提供します。