クイックスタート
Blume をインストールし、新しいプロジェクトを作成して、数分で最初のドキュメントページを公開しましょう。その後は自分のペースで本格的なサイトへと育てていけます。
空のフォルダから、いくつかのコマンドだけで動作するドキュメントサイトまで到達できます。Blume に必要なのは Node.js 22.12 以降と、.md または .mdx ファイルを 1 つ以上含む docs/ フォルダだけです。それ以外に用意するものはありません。
インストールと実行
Blume をインストールする
新規または既存のプロジェクトにパッケージを追加します。
npm install blumepnpm add blumeyarn add blumebun add blumeプロジェクトを作成する
blume init はいくつかの質問をします — プロジェクトを作成する場所、ドキュメントサイトの名前、使用するテンプレート、コンテンツの配置場所 — そのうえで最小限の構成、つまりコンテンツフォルダと設定ファイルを生成します。プロンプトをスキップしてデフォルト値を使うには --yes を渡してください。
blume initdocs/
index.mdx
blume.config.ts開発サーバーを起動する
Blume がランタイムを生成し、ホットリロード付きでドキュメントを配信します。
blume dev本番向けにビルドする
静的 HTML が dist/ に出力され、それを対象としたローカル検索インデックスが構築されます。
blume build最初のページを書く
すべてのページは、少しのフロントマターを添えた 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.
:::保存すれば、開発サーバーが即座にリロードします。ナビゲーション、検索、ページメタデータは、ファイルを追加するたびにそれらから推論されます。書き続けるだけで、サイトがついてきます。