【mdBook】1 安装
有多种方式可以安装 mdBook CLI 工具。请选择以下任一适合您需求的方法。如果您是为了自动部署而安装 mdBook,请查看持续集成章节以获取更多安装示例。
预编译二进制文件
可在 GitHub Releases 页面下载可执行的二进制文件。下载适用于您平台(Windows、macOS 或 Linux)的二进制文件并解压存档。存档包含一个 mdbook
可执行文件,您可以运行它来构建您的书籍。
为了更方便地运行,请将二进制文件所在路径添加到您的 PATH 环境变量中。
使用 Rust 从源码构建
要从源码构建 mdbook
可执行文件,您首先需要安装 Rust 和 Cargo。请按照 Rust 安装页面上的说明进行操作。mdBook 目前至少需要 Rust 1.82 版本。
安装完 Rust 后,可以使用以下命令来构建和安装 mdBook:
cargo install mdbook
这将自动从 crates.io 下载 mdBook,进行构建,并将其安装到 Cargo 的全局二进制目录(默认为 ~/.cargo/bin/
)。
当您想更新到新版本时,可以再次运行 cargo install mdbook
。该命令将检查是否有更新的版本,并在找到新版本时重新安装 mdBook。
要卸载,请运行命令 cargo uninstall mdbook
。
安装最新的主版本(master)
发布到 crates.io 的版本可能会略微落后于 GitHub 上托管的版本。如果您需要最新版本,可以自行构建 mdBook 的 git 版本。Cargo 使这变得非常容易!
cargo install --git https://github.com/rust-lang/mdBook.git mdbook
同样,请确保将 Cargo 的二进制目录添加到您的 PATH 环境变量中。
修改与贡献
如果您有兴趣对 mdBook 本身进行修改,请查看贡献指南以获取更多信息。