当前位置: 首页 > news >正文

【mdBook】6 在持续集成中运行 mdbook - 指南

有多种服务(如 GitHub Actions 或 GitLab CI/CD)可用于自动测试和部署您的书籍。

以下提供了一些关于如何配置服务来运行 mdBook 的通用指南。具体的使用方法可以在"自动部署" Wiki 页面找到。

安装 mdBook

有几种不同的安装 mdBook 的策略。具体方法取决于您的需求和偏好。

预编译二进制文件

也许最简单的方法是使用 GitHub Releases 页面上的预编译二进制文件。一个简单的方法是使用流行的 curl 命令行工具下载可执行文件:

mkdir bin
curl -sSL https://github.com/rust-lang/mdBook/releases/download/v0.4.52/mdbook-v0.4.52-x86_64-unknown-linux-gnu.tar.gz | tar -xz --directory=bin
bin/mdbook build

这种方法的考虑因素:

  • 速度较快,不一定需要处理缓存
  • 不需要安装 Rust
  • 指定特定 URL 意味着您必须手动更新脚本以获取新版本。如果您想锁定特定版本,这可能是一个好处。但有些用户更喜欢在发布时自动获取新版本
  • 依赖 GitHub CDN 的可用性

从源码构建

从源码构建需要安装 Rust。有些服务已预装 Rust,但如果您的服务没有,则需要添加安装步骤。

安装 Rust 后,可以使用 cargo install 来构建和安装 mdBook。我们建议使用 SemVer 版本说明符,以便获得最新的不破坏兼容性的 mdBook 版本。例如:

cargo install mdbook --no-default-features --features search --vers "^0.4" --locked

这包含几个推荐选项:

选项说明
--no-default-features禁用 CI 上可能不需要的功能(如 mdbook serve 使用的 HTTP 服务器),显著加快构建时间
--features search禁用默认功能后,应手动启用所需功能(如内置搜索功能)
--vers "^0.4"安装 0.4 系列的最新版本,但不会安装 0.5.0 等后续版本(可能破坏构建)
--locked使用 mdBook 发布时使用的依赖版本,避免使用最新依赖可能导致的构建问题

您可能需要研究缓存选项,因为构建 mdBook 可能有些慢。

运行测试

您可能希望在每次推送更改或创建拉取请求时使用 mdbook test 运行测试。这可用于验证书中的 Rust 代码示例。

这需要安装 Rust。有些服务已预装 Rust,但如果您的服务没有,则需要添加安装步骤。

除了确保安装适当版本的 Rust 外,只需从书籍目录运行 mdbook test 即可。

您可能还想考虑运行其他类型的测试,例如:

  • mdbook-linkcheck:检查损坏的链接
  • 自定义样式检查、拼写检查器或其他测试

部署

您可能希望自动部署您的书籍。有些人可能希望在每次推送更改时部署,而其他人可能只想在标记特定版本时部署。

您还需要了解如何将更改推送到 Web 服务的具体细节。例如:

基本流程是运行 mdbook build 生成输出,然后将文件(位于 book 目录中)传输到正确的位置。

您可能还需要考虑是否需要在 Web 服务上使任何缓存失效。

有关各种不同服务的示例,请参阅"自动部署" Wiki 页面。

404 处理

mdBook 会自动生成用于损坏链接的 404 页面。默认输出是位于书籍根目录下名为 404.html 的文件。

  • GitHub Pages 等服务会自动将此页面用于损坏链接
  • 其他服务可能需要配置 Web 服务器使用此页面,以便为读者提供返回书籍的导航

站点 URL 配置

如果您的书籍未部署在域的根目录下,则应设置 output.html.site-url,以便 404 页面正常工作。它需要知道书籍的部署位置才能正确加载静态文件(如 CSS)。

示例:本指南部署在 https://rust-lang.github.io/mdBook/,站点 URL 设置如下:

# book.toml
[output.html]
site-url = "/mdBook/"

自定义 404 页面

您可以通过在书籍中创建名为 src/404.md 的文件来自定义 404 页面的外观。如果要使用不同的文件名,可以将 output.html.input-404 设置为其他文件名。

http://www.jsqmd.com/news/27660/

相关文章:

  • Allegro丨17.4 导出导入封装与网表
  • 2025 年 OKR 培训教练最新推荐榜,技术实力与市场口碑深度解析,助力企业战略落地OKR 落地/OKR 管理/OKR 认证/OKR 目标管理顾问推荐
  • nrf52840 USB Mass Storage 通信原理是什么?
  • Nordic 芯片如何快速调整PWM 占空比生效?
  • 【2025最新教程】电脑怎么连接打印机?从USB到WiFi的全方位图文教学
  • 2025年码垛桁架机械手生产厂家权威推荐榜单:桁架搬运机械臂/桁架机器人/桁架搬运机械臂源头厂家精选
  • 人类智慧
  • 2025 年 10 月防静电地板厂家推荐排行榜,全钢/全钢陶瓷/硫酸钙/铝合金/pvc架空/防静电地板,OA网络地板,机房防静电地板,办公室网络架空地板公司推荐
  • 开源神器MinerU:一键提取PDF内容的工具 - yi
  • Python创建类(上)_ 没对象?实例化一个
  • 2025年隧道装备公司新推荐排行榜,开创星隧道装备等公司推荐
  • 0307-Nand-实现类
  • 互信息MI
  • Allegro丨17.4 操作记录
  • 0306-Nand-解析和绑定
  • 0305-Nand-函数
  • Nginx + Lua 实现每日访问次数限制与防盗链校验
  • Photoshop 2026 v27.0正式版终于来了,AI 加持让创意更自由
  • 大故障,阿里云核心域名疑似被劫持 - 教程 (转载)
  • 学习笔记:乘法逆元
  • 2025年北京保洁服务公司推荐:海獭顾家保洁服务公司深度测评
  • 三角函数:从入门到入门
  • 1063:最大跨度值
  • 学术会议合集 | 机器人、大数据、社会科学、医学人工智能等EI会议合集
  • 基于块匹配的MATLAB视频去抖动算法
  • 2025年回转窑干燥机设备定制厂家权威推荐榜单:回转窑滚筒干燥机/回转窑设备/回转窑干燥机源头厂家精选
  • 资源字典(ResourceDictionary)学习笔记
  • 2025年电子设备厂家年度排名推荐,幸运电子设备有限公司
  • 如何一句话证明你懂项目管理或当过项目经理?
  • linux 使用指南