Blume: 設定不要の資料作成ツール

OpenAIの熟練開発者であるHayden Bleasel氏が、オープンソースのドキュメンテーション framework であるBlumeをリリースしました。Blumeは同日、バージョン1.0.3としてnpmに公開されました。Markdownファイルをフォルダに入れるだけで、ドキュメントサイトを公開できるほどシンプルです。その後、アプリのボイラープレートを作成したり保守したりする必要はありません。このプロジェクトはMIT-licensedで、オープンソースです。Blumeとは？ Blumeは、ドキュメント用のコンポーネントライブラリと組み合わされたcommand-line toolです。MarkdownまたはMDXファイルのフォルダを読み込みます。そのフォルダから、本番環境レベルのドキュメンテーションサイトを生成します。その出力には、ナビゲーション、検索、テーマ設定、およびOpen Graph画像が含まれます。設定はオプションであり、ファイルごとに1つずつ追加されます。コードはTypeScript monorepoであり、公開されているpackageはpackages/blumeにあります。apps/docsにあるBlume自身のドキュメンテーションも、Blume自身で構築されています。Node.js 22.12以降が必要です。Bun、pnpm、npm、またはyarnで実行できます。Blumeの仕組みは？ 内部では、Blumeは隠れたAstroプロジェクトを生成し、駆動します。まず、CLIはblume.config.tsを読み込み、コンテンツをグラフにスキャンします。次に、Astroプロジェクトを.blume/ディレクトリに書き込みます。その後、Astroは単一のcatch-all routeを介してすべてのページをレンダリングします。このrouteは、Blumeの提供するcomponents、生成されたデータ、およびユーザーのoverrideをインポートします。実行ごとに.blume/は再生成され、変更されたファイルのみが書き換えられます。その結果、編集中のhot reloadは高速に保たれます。コアテーマにはclient framework JavaScriptは含まれていません。結果として、ページはデフォルトでCore Web Vitalsで高いスコアを獲得します。完全な制御が必要な場合、blume ejectはランタイムをスタンドアロンのAstroアプリに昇格させます。このejectedされたプロジェクトは、依然としてblume packageに依存します。blume devを実行します。