インストール

mdBookのCLIツールをインストールする方法はいくつかあります。以下から、必要に合った方法を選んでください。自動デプロイのためにmdBookをインストールする場合は、継続的インテグレーションの章にもインストール例があります。

コンパイル済みバイナリー

実行可能なバイナリーはGitHubのリリースページからダウンロードできます。利用するプラットフォーム(Windows、macOS、Linux)用のバイナリーをダウンロードし、アーカイブを展開してください。アーカイブには、本をビルドするためのmdbook実行ファイルが含まれています。

実行しやすくするため、バイナリーのあるディレクトリをPATHに追加してください。

Rustでソースからビルドする

mdbook実行ファイルをソースからビルドするには、まずRustとCargoのインストールが必要です。Rustのインストールページの手順に従ってください。本版のmdBookにはRust 1.88以上が必要です。

Rustのインストール後は、次のコマンドでmdBookをビルドしてインストールできます。

cargo install mdbook

このコマンドは、crates.ioからmdBookを自動でダウンロードし、ビルドして、Cargoの共通バイナリーディレクトリ(既定では~/.cargo/bin/)にインストールします。

新しいバージョンに更新したいときは、cargo install mdbookを再実行できます。新しいバージョンがあるか確認し、見つかった場合はmdBookを再インストールします。

アンインストールするには、cargo uninstall mdbookコマンドを実行します。

masterの最新版をインストールする

crates.ioで公開されるバージョンは、GitHub上のバージョンよりわずかに遅れます。最新版が必要なら、GitにあるmdBookを自分でビルドできます。Cargoを使えば、これはとても簡単です。

cargo install --git https://github.com/rust-lang/mdBook.git mdbook

この場合も、CargoのバイナリーディレクトリをPATHに追加してください。

変更と貢献

mdBook自体を変更したい場合は、貢献ガイドに詳しい説明があります。