Command Line Tool

mdBook既可以用作命令行工具,也可以用作Rust crate。让我们首先关注命令行工具功能.

二进制

在尽力而为的基础上,预先编译主要平台的二进制文件。访问 releases 页面下载适合您平台的版本.

源码安装

mdBook也可以从源代码安装

Pre-requisite

mdBook是写的 Rust 因此需要Cargo编译。如果您还没有安装Rust，请现在就官方安装。

安装 Crates.io 的版本

如果您已安装Rust和Cargo,则安装mdBook相当容易。您只需在终端中键入以下代码段:

  1. cargo install mdbook

这将在Crates.io获取最新版本的源代码，并编译它。你需要添加Cargo的bin目录，到你的环境变量PATH.

在您的终端，运行mdbook help验证它是否有效。

恭喜你,你已经安装了mdBook!

安装 Git 版本

该 git 版本 包含所有最新的错误修复和功能, 且是在下一个版本中才发布Crates.io, 如果你不能等到下一个版本。你可以自己构建git版本。打开终端，并导航到您选择的目录。我们需要克隆git存储库,然后使用Cargo构建它.

  1. git clone --depth=1 https://github.com/rust-lang-nursery/mdBook.git
  2. cd mdBook
  3. cargo build --release

可执行文件mdbook输出在./target/release文件夹,这应该添加到环境变量PATH中，方便使用。