安装
这里由很多途径来安装mdBook命令行工具。您可以选择最适合您的方式进行安装。如果你想通过自动部署的方式来使用 mdbook ,可以参考持续集成的章节更多的示例。
已经编译的可执行程序
可以在GitHub Releases page下载适用于您使用操作系统的可执行文件(Windows,macOS or Linux)以及源代码的压缩文件。
为了方便使用,建议将执行文件的路径添加到您的PATH路径上
通过Rust编译源代码的方式构建
为了通过源代码编译的方式生成mdbook程序,您首先需要安装Rust 程序 和 Cargo.可以参考 Rust installation page.注意 mdbook 需要 Rust 版本在1.54 以上。
安装Rust程序以后,可以通过下面的命令编译及安装 mdBook:
cargo install mdbook
cargo 将自动从 crates.io下载mdBook 源代码,进行编译和安装。生成的可执行文件被生成在 Cargo全局执行目录 (~/.cargo/bin/
默认).
安装最新版本
在 crates.io上发布的mdbook 不是最新版本的(略低于最新版本),如果需要最新版本可以通过Cargo 从 GitHub 构建最新的版本,这是非常容易的,运行下面的命令:
cargo install --git https://github.com/rust-lang/mdBook.git mdbook
在运行cargo前,一定要确认 cargo 可执行路径已经加到您的 PATH 里
如果您有兴趣对 mdBook 本身进行修改,请查看 贡献指南 了解更多信息。