CLIツール
haydenbleasel/blume avatar
haydenbleasel/blume

Blume: Markdownフォルダから構成不要のドキュメントサイトを生成

haydenbleasel/blumeは実運用向けに使える実用的なオープンソース実装で、再利用可能な導入ルートを持つプロジェクトです。

スター 1,636フォーク 97TypeScriptMIT

ひと目でわかる

これは何?
MarkdownまたはMDXから本番向けドキュメントサイトを構築するTypeScript CLI。ローカル検索、コンポーネント、SEO、AI対応を内蔵し、スターターもフレームワーク設定も不要。
誰に向いている?
BlumeはMITライセンスで公開されており、READMEはリポジトリ自身のドキュメントサイト apps/docs がBlumeで構築されていると述べている。READMEはホスト型MCPサーバーのインフラやAsk AIアシスタントの設定方法については触れておらず、それらの詳細はプロジェクトドキュメントに委ねられている。
商用利用できる?
できます。MIT は寛容なライセンスで、著作権表示とライセンス表示を残せば、使用・改変・販売が可能です。
今もメンテナンスされている?
されています。最後のコミットは 1 日前です。
何の言語で書かれている?
主に TypeScript です(GitHub の言語統計による)。

回答はプロジェクトの GitHub データ(最終同期:2026年9月15日)と当サイトの分析に基づくもので、法的助言ではありません。

オープンソース詳細解説

BlumeがMarkdownフォルダに課す前提

BlumeのREADMEは「ビルドするすべてのもののためのドキュメント」という説明で始まり、その中心的な主張は、MarkdownまたはMDXファイルを入れたフォルダがそのまま完全なプロジェクトになるというものだ。スターターをクローンする必要も、フレームワークを学ぶ必要もない。`blume dev` を実行すると、Blumeはナビゲーション、検索、テーマ、Open Graph画像、コンポーネントライブラリを備えたドキュメントサイトを生成する。アプリのボイラープレートを書いたり保守したりする必要はない。このツールは隠しAstroプロジェクトを生成して駆動し、完全な制御が必要になった時は `blume eject` でそのランタイムを独立したAstroアプリに昇格できる。READMEは、コンテンツを追加する前の生成サイトの姿や、ejectがリポジトリに何をもたらすかについては説明していない。

Bunで始めるゼロ設定の生成

文書化された要件は、Node.js 22.12以上と、`.md` または `.mdx` ファイルを少なくとも1つ含むコンテンツフォルダだ。READMEは `npx blume init` でプロジェクトをスキャフォールドし、`blume dev` でホットリロード付きの開発サーバーを起動し、`blume build` でローカル検索インデックス付きの静的HTMLを `dist/` にビルドすると示している。Blumeはどのパッケージマネージャーでも動作し、AstroやTailwindを自分でセットアップする必要は一切ないとしている。READMEは `init` が対話的に何を尋ねるかや、コンテンツフォルダ以外にどのファイルを作成するかについては触れていない。

検索、ナビゲーション、コード表示の構成

機能リストは広範だ。検索は開発・本番の両方でOramaを介してローカルに実行され、FlexSearch、Pagefind、Algolia、Typesense、Orama Cloud、Mixedbreadが設定可能な代替として挙げられている。コアテーマはクライアントフレームワークのJavaScriptを含まないため、ページはAstroとViteによる静的HTMLだ。MDXページはインポートなしでコンポーネントを使用でき、カード、カラム、ステップ、タブ、アコーディオン、バッジ、コードグループ、フレーム、ファイルツリー、型テーブル、ライブコンポーネントプレビュー、差分表示などがある。SEO機能には、メタデータ、ビルド時にTakumiでレンダリングされるOpen Graph画像、sitemap、robots.txt、RSSフィード、JSON-LDが含まれる。国際化は翻訳ファイルを所定の場所に置くだけで処理され、ロケール対応ルーティング、言語ごとのナビゲーション、翻訳されたUIを提供する。読者は任意のページを完全にクライアントサイドでPDFまたはEPUBにエクスポートできる。APIリファレンスはScalar経由でOpenAPIまたはAsyncAPI仕様からレンダリングされ、スキーマ、認証、リクエストプレイグラウンドを備える。カスタマイズはコンポーネントオーバーライド、React islands、カスタムページ、Tailwind v4テーマトークン、`blume add` によるソースコンポーネントレジストリで行える。

AI向けfrontmatterとコンテンツソース

READMEは「AI対応」の下にいくつかの機能をまとめている:`llms.txt` と `llms-full.txt` ファイル、任意の `.md` URLでの生のMarkdown、Markdownとしてコピー、チャットで開く、オプションのAsk AIアシスタント、そしてコーディングエージェントがドキュメントを直接検索・閲覧できるホスト型MCPサーバーだ。また、コーディングエージェントにドキュメントサイトのスキャフォールド、作成、保守を教えるエージェントスキルも同梱される。コンテンツソースはローカルファイルと、リモートMDX、GitHub Releases、Notion、Sanity、カスタムバックエンドを単一サイトに混在させることができ、`blume sync` はリモートソースを再取得する。READMEはMCPサーバーのホスティング方法やAsk AIアシスタントの設定方法については触れていない。

Markdownから静的サイトになる流れ

CLIは `blume.config.ts` を読み込み、コンテンツをグラフにスキャンし、`.blume/` の下に隠しAstroプロジェクトを生成して、開発とビルドを駆動する。Astroは、Blumeが同梱するコンポーネント、生成されたデータ、そしてユーザーのオーバーライドをインポートするcatch-allページを通じてレンダリングする。`.blume/` ディレクトリは実行のたびに再生成されるが、変更されたファイルだけが書き込まれるため、ホットリロードは高速に保たれる。`blume eject` を実行してプロジェクトを所有するまで、その状態が続く。設定と各 `meta.ts` は実際のTypeScriptであり、スキーマで検証され、`defineConfig` と `defineMeta` で作成されるため、エディタのチェックがビルド前にエラーを検出できる。

Vercel、Netlify、Nodeへのデプロイ

CLIリファレンス表には10のコマンドが並ぶ:`init` はデフォルトで対話的にプロジェクトをスキャフォールドし、`dev` は開発サーバーを起動し、`build` は静的またはサーバーサイトをビルドし、`preview` は最後のビルドをプレビューし、`add` はレジストリからソースコンポーネントをインストールし、`sync` はリモートコンテンツを再取得し、`eject` はランタイムを独立したAstroアプリに昇格し、`check` は `astro check` で型チェックし、`validate` は内部・アンカー・アセット・外部リンクを検証し、`doctor` は設定とコンテンツの問題を診断する。デプロイに関しては、`blume build` は静的HTMLを `dist/` に出力するため、任意の静的ホストで配信できる。Ask AIやMCPサーバーのようなリクエスト時機能には、サーバー出力に切り替えてアダプターを選ぶようREADMEは述べている:Vercel、Netlify、Node、Cloudflareのいずれかで、Vercel、Netlify、Cloudflare PagesではアダプターとサイトURLが自動検出される。

Blume自身のcheckとMITライセンス

リポジトリはモノレポ構成で、公開パッケージは `packages/blume` にあり、`apps/docs` はBlume自身がBlumeで構築したドキュメントだ。開発にはBunを使用し、`bun install`、`bun run check`(Ultraciteによるlintとフォーマット)、`bun run typecheck`、`bun run test` を実行する。READMEはアーキテクチャと規約についてCONTRIBUTING.mdを参照するよう促すが、その内容は要約していない。プロジェクトはMITライセンスで、著作権はHayden Bleaselにある。ライセンスは使用、コピー、修正、マージ、公開、配布、再ライセンス、販売の権利を許諾し、ソフトウェアは「現状のまま」提供され、いかなる種類の保証もないと述べている。ライセンス抜粋は、セキュリティ態勢、サポートの約束、本番保証については何も述べていない。

編集部の結論

BlumeはMITライセンスで公開されており、READMEはリポジトリ自身のドキュメントサイト apps/docs がBlumeで構築されていると述べている。READMEはホスト型MCPサーバーのインフラやAsk AIアシスタントの設定方法については触れておらず、それらの詳細はプロジェクトドキュメントに委ねられている。

公式情報源

  1. Official documentation
  2. Official README
  3. Project repository
  4. Release notes
コミュニティノート

コミュニティノート