安装
mdBook有很多种安装方式,选择以下任何一种最适合你的方法。
如果你需要自动化部署mdBook,请查看持续集成一章,了解有关如何安装的更多示例。
下载二进制包安装
在官方的Github,选择匹配你操作系统(Windows, macOS, 或者 Linux)的安装包。
下载后,解压安装包,解压后包含mdbook
这个可执行文件。
为了以后方便使用,可以吧mdbook
所在的文件加入你操作系统的环境变量PATH
中。
源码安装
想要源码安装mdbook
你首先需要安装Rust和Cargo
按照Rust安装说明上的说明进行操作。mdBook当前至少需要Rust版本1.56。
安装Rust后,可以使用以下命令构建和安装mdBook:
cargo install mdbook
这将自动从crates.io下载依赖构建mdBook,并将其安装在Cargo的全局二进制目录中(默认为~/.cargo/bin/
)。
如果要卸载程序, 执行命令cargo uninstall mdbook
.
安装最新版本
发布到crates.io
的版本将略微落后于GitHub上托管的版本。
如果您需要最新版本,您可以自己构建mdBook的git版本。
Cargo让这件事变得 超级简单!!
cargo install --git https://github.com/rust-lang/mdBook.git mdbook
同样的确保将Cargo bin目录添加到PATH
中。
如果您对修改mdBook本身感兴趣,请查看投稿指南了解更多信息。