クイックスタート
Blume をインストールし、新しいプロジェクトを作成して、数分で最初のドキュメントページを公開しましょう。その後は自分のペースで本格的なサイトへと育てていけます。
空のフォルダから、いくつかのコマンドだけで動作するドキュメントサイトまで到達できます。Blume に必要なのは Node.js 22.19 以降と、.md または .mdx ファイルを 1 つ以上含む docs/ フォルダだけです。それ以外に用意するものはありません。
インストールと実行
プロジェクトを作成する
blume init はいくつかの質問をします — プロジェクトを作成する場所、ドキュメントサイトの名前、使用するテンプレート、コンテンツの配置場所 — そのうえで最小限の構成、つまりコンテンツフォルダ、設定ファイル、dev、build、doctor スクリプトを含む package.json、さらに node_modules/、生成された .blume/、dist/、.env.local（ローカルのシークレットの保存先）をバージョン管理から除外する .gitignore を生成します。依存関係は、blume init を実行したパッケージマネージャーでインストールされます。プロンプトをスキップしてデフォルト値を使うには --yes を、ファイルの書き出しだけを行うには --no-install を渡してください。
npx blume initpnpm dlx blume inityarn dlx blume initbunx blume initnubx blume initaube dlx blume initpnpm 12 では、pnpm dlx の後に --allow-build=esbuild を追加してください（pnpm dlx --allow-build=esbuild blume init）。pnpm 12 は、Astro が依存している esbuild のインストールスクリプトを、承認しない限り実行しないためです。既存の pnpm ワークスペース内では、新しいフォルダをワークスペースの packages に記載する必要があります（pnpm はそれ以外のものを一切インストールしないため、記載されるまで init はインストールをスキップします）。また、esbuild のためにワークスペースの pnpm-workspace.yaml に allowBuilds: { esbuild: true } を追加する必要があります。init はこの両方を案内します。Yarn 2 以降では、init が .yarnrc.yml を書き出し、Blume に必要な node_modules 方式のインストールに Yarn を切り替えます。Yarn 1 では npx blume init を実行してください。
docs/
index.mdx
.gitignore
blume.config.ts
package.json開発サーバーを起動する
プロジェクトディレクトリで実行すると、Blume がランタイムを生成し、ホットリロード付きでドキュメントを配信します。
npm run devpnpm run devyarn run devbun run devnub run devaube run dev本番向けにビルドする
静的 HTML が dist/ に出力され、それを対象としたローカル検索インデックスが構築されます。
npm run buildpnpm run buildyarn run buildbun run buildnub run buildaube run buildすでに package.json があるプロジェクトに Blume を追加する場合は、blume init が既存のファイルに手を加えず、インストールもスキップするため、Blume を自分でインストール（npm install blume）したうえで、その scripts に "dev": "blume dev" と "build": "blume build" を追加するか、npx blume dev を直接実行してください。init が表示する次のステップには、お使いのパッケージマネージャー向けにこの両方のコマンドが記載されています。
最初のページを書く
すべてのページは、少しのフロントマターを添えた Markdown または MDX です。title と description は自動的にページの見出しとイントロとして表示されます。次の内容を docs/index.mdx に貼り付けてみましょう。
---
title: Introduction
description: Welcome to my docs.
---
Welcome! Use **Markdown** and built-in components — no imports required:
:::note
Blume ships callouts, cards, tabs, steps, and more.
:::保存すれば、開発サーバーが即座にリロードします。ナビゲーション、検索、ページメタデータは、ファイルを追加するたびにそれらから推論されます。書き続けるだけで、サイトがついてきます。