简介

mdBook 是一个使用Markdown来创建在线书籍的命令行工具。 它非常适合创建产品或API文档、教程、课程材料或任何需要干净、易于导航和可定制的演示文稿。

本指南就是由mdBook生成的示例。 mdBook被Rust编程语言项目使用，Rust语言官方《rust语言指导》书市mdBook的另一个很好的例子。

贡献代码

mdBook是免费和开源的。 您可以在GitHub上找到源代码. 问题和功能请求可以发布在GitHub 问题跟踪器。 mdBook依靠社区来修复bug和添加新的功能：如果您想贡献代码，请先阅读贡献代码指南,然后他分支，提交PR。

License

mdBook源代码和文档发布于Mozilla Public License v2.0。

安装

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本身感兴趣，请查看投稿指南了解更多信息。

阅读说明

本章介绍如何阅读mdBook制作的书籍，HTML在线书籍和其他输出格式（如PDF）的书籍格式有所不同。

书籍以章节 形式组成,每一节都是单独的一页。很多节按照顺序构成一章。通常每一节以标题列表的方式镶嵌在数据的一章中。

导航

浏览书籍章节有好几种方法。

左侧的侧边栏提供了所有章节的列表，单击任何章节标题将加载该页面。

如果窗口太窄，特别是在移动显示器上，侧边栏可能不会自动显示。在这种情况下，可以按下页面左上方的菜单图标（三个水平条）来打开和关闭侧边栏。

页面底部的箭头按钮可用于导航到上一章或下一章。

键盘上的左右箭头键可用于导航到上一章或下一章。

顶部菜单栏

页面顶部的菜单栏提供了一些与书籍交互的图标。显示的图标将取决于配置。

Icon描述
打开或打开侧边栏
打开选择器以选择不同的颜色主题。
打开搜索栏以在书本中搜索。
使用web浏览器打印整本书。
打开指向该书源代码的Github地址的链接。
打开页面以直接编辑当前正在阅读的页面的源代码。

点击菜单栏将页面滚动到顶部.

搜索

每本书都有一个内置的搜索系统。 单机顶部菜单栏搜索图标() ,或者按键盘上的“S”键将打开搜索框。 输入一些关键词将实时显示匹配的章节和部分. 单击任何结果都将跳转到该部分。向上和向下箭头键可用于导航结果，按键盘确认键将打开突出显示的部分。 加载搜索结果后，匹配的关键字将在文本中突出显示。单击突出显示的单词或按“Esc”键将删除突出显示。

代码块

mdBook books are often used for programming projects, and thus support highlighting code blocks and samples. Code blocks may contain several different icons for interacting with them: mdBook书籍通常用于编程项目，因此支持高亮显示代码块和代码示例。

代码块可能包含几个不同的图标用于与它们交互：

IconDescription
将代码块复制到本地剪贴板，以允许粘贴到另一个应用程序。
对于 Rust 代码示例，这将执行示例代码并在示例下方显示编译器输出（请参阅 playground）。
对于 Rust 代码示例，这将切换“隐藏”行的可见性。 有时，较大的示例会隐藏与所说明内容不特别相关的行（请参阅 隐藏代码行).
对于可编辑代码示例编辑器，这将撤消您所做的任何更改。

这里是一个例子:

#![allow(unused)]
fn main() {
println!("Hello, World!");
}

创建书籍

一旦安装了 mdbook 命令行工具，您就可以使用它来创建和渲染一本HTML书籍。

初始化书籍

mdbook init 命令将创建一个包含一本空书的新目录。 为它指定要创建的目录的名称：

mdbook init my-first-book

在生成书之前，它会在命令行交互几个问题。 输入问题后，就可以把当前目录改成新书目录了：

cd my-first-book

渲染书籍的方法有多种，但最简单的方法之一是使用serve命令，它将构建您的书籍并启动本地网络服务器：

mdbook serve --open

--open 选项将打开您的默认网络浏览器以查看您的新书。 即使在编辑本书内容时，您也可以让服务器保持运行状态，mdbook 将自动重建输出并自动刷新您的网络浏览器。

查看 命令行 以获取有关其他 mdbook 命令和 CLI 选项的更多信息.

一本书的组成

一本书是由几个文件构建的，这些文件定义了书的设置和布局。

book.toml

在你的书的根目录中，有一个book.toml文件描述如何构建你的书的配置。 他是用 TOML 标记语言 编写的. 通常默认设置足以让你使用。 如果您有兴趣探索 mdBook 提供的更多功能和选项，请查看 配置 了解更多详细信息。

一个非常基本的 book.toml 可以这么简单:

[book]
title = "My First Book"

SUMMARY.md

本书的下一个主要部分是位于 src/SUMMARY.md 的摘要文件。 该文件包含本书所有章节的列表。 在查看章节之前，必须将其添加到此列表中。

这是一个包含几章的基本摘要文件：

# Summary

[Introduction](README.md)

- [My First Chapter](my-first-chapter.md)
- [Nested example](nested/README.md)
    - [Sub-chapter](nested/sub-chapter.md)

尝试在编辑器中打开 src/SUMMARY.md 并添加几章。 如果任何章节文件不存在，mdbook 会自动为您创建它们。

有关摘要文件的其他格式化选项的更多详细信息，请查看SUMMARY.md。

Source files

你的书的内容都包含在 src 目录中。 每一章节都是一个单独的Markdown文件。 通常，每一都以带有章节标题的1级标题开始。

# 第一章

内容输入在这里

文件的精确布局由您决定。 文件的组织将与生成的 HTML 文件相对应，因此请记住，文件布局是每章URL的一部分。

当 mdbook serve 命令运行时，您可以打开任何章节文件并编辑它们。 每次保存文件时，mdbook 都会重建这本书并刷新您的网络浏览器。

查看 Markdown 以获取有关格式化章节内容的更多信息。

src 目录中的所有其他文件都将包含在输出中。 因此，如果您有图像或其他静态文件，只需将它们包含在 src 目录中的某个位置。

发布书籍

写完书后，您可能希望将它放在某个地方供其他人查看。 第一步是构建本书的输出。 这可以在book.toml文件所在的同一目录中使用 mdbook build 命令来完成：

mdbook build

这将生成一个名为book的目录，其中包含您的书的HTML内容。 然后，您可以将此目录放在任何Web服务器上以托管它。

有关发布和部署的更多信息，请查看 持续集成 了解更多。

命令行工具

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

二进制文件安装

我们尽最大努力为主要平台提供了预编译的二进制文件。 访问发布页面以下载适合您平台的版本。

源码安装

mdBook 也可以通过在本地机器上编译源代码来安装。

先决条件

mdBook 是用 Rust 编写的，因此需要用 Cargo 编译。 如果您还没有安装 Rust，请立即安装。

安装 Crates.io 版本

如果您已经安装了 Rust 和 Cargo，则安装 mdBook 相对容易。 你只需要在你的终端中输入这段代码：

cargo install mdbook

这将从 Crates.io 获取最新版本的源代码并编译它。 您必须将 Cargo 的 bin 目录添加到您的 PATH 环境变量中。

在终端中运行 mdbook help 以验证它是否有效。 恭喜，您已经安装了 mdBook！

安装 Git 版本

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

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

可执行文件 mdbook 将在 ./target/release 文件夹中，这应该添加到PATH 环境变量中。

init 命令

每本新书都有一些相同的最小模板。 为此，mdBook 包含了一个 init 命令。

init 命令的用法如下：

mdbook init

第一次使用 init 命令时，会为你设置几个文件：

book-test/
├── book
└── src
    ├── chapter_1.md
    └── SUMMARY.md
  • src 目录是你用 Markdown 写书的地方。 它包含所有源文件、配置文件等。
  • book 目录是你的书被渲染的地方。 所有输出都已准备好上传到服务器以供观众查看。
  • SUMMARY.md 是本书的骨架，将在另一章中进行更详细的讨论。

提示：从 SUMMARY.md 生成章节

当一个SUMMARY.md文件已经存在时，init命令会首先解析它并根据SUMMARY.md中使用的路径生成不存在的文件。 这允许您思考和创建您的书的整个结构，然后让 mdBook 为您生成它。

指定目录

init 命令可以将目录作为参数用作书的根目录而不是当前工作目录。

mdbook init path/to/book

--theme

当您使用 --theme 参数时，默认主题将被复制到源目录中名为 theme 的目录中，以便您可以对其进行修改。

主题被选择性覆盖，这意味着如果您不想覆盖特定文件，只需将其删除即可使用默认文件。

--title

指定书名。 如果未提供，交互式提示将要求提供标题。

mdbook init --title="my amazing book"

--ignore

创建一个 .gitignore 文件，配置为忽略构建书籍时创建的 book 目录。 如果未提供，交互式提示将询问是否应创建。

build 命令

build 命令用于渲染书籍：

mdbook build

它将尝试解析您的SUMMARY.md文件以了解您的书的结构并获取相应的文件。 请注意在 SUMMARY.md 中提到但不存在的文件将会自动创建。

为方便起见，渲染的输出将保持与源相同的目录结构。 大量的books在渲染时将保持结构化。

指定目录

build命令可以将目录作为参数用作书的根目录而不是当前工作目录。

mdbook build path/to/book

--open

当您使用--open (-o) 标志时，mdbook 在构建后, 将在你默认的网页浏览器中打开渲染的书籍。

--dest-dir

--dest-dir (-d) 选项允许您更改书籍的输出目录。 相对路径是相对于书的根目录解释的。 如果未指定，它将默认为book.toml 中 build.build-dir 键的值，或为 ./book。

注意:: build 命令将所有文件（不包括扩展名为 .md 的文件）从源目录复制到build目录中。

watch 命令

当您希望在每次文件更改时呈现您的书籍时，watch命令很有用。 每次更改文件时，您都可以重复发出mdbook build。 但是使用mdbook watch将监视您的文件，并在您修改文件时自动触发构建； 这包括重新创建已删除的但在SUMMARY.md中但仍然提到的文件！

指定目录

watch命令可以将目录作为参数用作书的根目录而不是当前工作目录。

mdbook watch path/to/book

--open

当您使用--open (-o) 选项时，mdbook 将在您的默认 Web 浏览器中打开渲染的书籍。

--dest-dir

--dest-dir (-d) 选项允许您更改书籍的输出目录。 相对路径是相对于书的根目录解释的。 如果未指定，它将默认为book.toml中build.build-dir键的值，或为 ./book。

指定排除模式

watch命令不会自动为book根目录中的.gitignore文件中列出的文件触发构建。 .gitignore文件可能包含gitignore文档中描述的文件模式。 这对于忽略某些编辑器创建的临时文件很有用。

注意: 仅使用书籍根目录中的.gitignore文件。 全局的$HOME/.gitignore或父目录中的.gitignore文件则不会被使用。

serve 命令

默认情况下serve命令用于通过HTTP在localhost:3000提供服务来预览一本书：

mdbook serve

serve命令监视书的src目录的变化，为每次变化将重建书籍和刷新客户端； 这包括重新创建已删除但仍然在SUMMARY.md中提到的文件！ websocket连接用于触发客户端刷新。

注意: serve命令用于测试一本书的HTML输出，并不打算成为网站的完整HTTP服务器。

指定目录

The serve 命令可以将目录作为参数用作书的根目录而不是当前工作目录。

mdbook serve path/to/book

Server 可选项

serve主机名默认为localhost，端口默认为3000。 可以在命令行上指定修改上述选项：

mdbook serve path/to/book -p 8000 -n 127.0.0.1

--open

当您使用 --open (-o) 标志时，mdbook 将在启动服务器后在您的默认 Web 浏览器中打开该书。

--dest-dir

--dest-dir (-d) 选项允许您更改书籍的输出目录。 相对路径是相对于书籍的根目录解释的。 如果未指定，它将默认为book.toml 中 build.build-dir 键的值或为 ./book。

指定排除模式

watch命令不会自动为书籍根目录中的.gitignore文件中列出的文件触发构建。 .gitignore文件可能包含gitignore文档中描述的文件模式。 这对于忽略某些编辑器创建的临时文件很有用。

注意: 仅使用书籍根目录中的.gitignore文件。 全局的$HOME/.gitignore或 父目录中的.gitignore文件则不会被使用。

test 命令

写书时，有时需要自动化一些测试。 例如The Rust Programming Book 使用了许多可能会过时的代码示例。 因此，能够自动测试这些代码示例对他们来说非常重要。

mdBook支持一个test命令，该命令将运行书中所有可用的测试。 目前，仅支持rustdoc测试，但将来可能会扩展。

在一个代码块上禁用测试

rustdoc不测试包含ignore属性的代码块：

```rust,ignore
fn main() {}
```

指定非Rust语言的代码块rustdoc也不测试：

```markdown
**Foo**: _bar_
```

rustdoc会测试没有指定语言的代码块： This is going to cause an error!

指定目录

test命令可以将目录作为参数用作书的根目录而不是当前工作目录。

mdbook test path/to/book

--library-path

--library-path (-L) 选项允许您将目录添加到rustdoc在构建和测试示例时使用的库搜索路径。 可以使用多个选项 (-L foo -L bar) 或逗号分隔列表 (-L foo,bar) 指定多个目录。 该路径应指向包含项目构建输出的Cargo构建缓存 deps目录。 例如，如果您的Rust项目的书籍位于名为my-book的目录中，则以下命令将在运行test时包含 crate 的依赖项：

mdbook test my-book -L target/debug/deps/

有关更多信息，请参阅rustdoc命令行文档。

--dest-dir

--dest-dir (-d) 选项允许您更改书籍的输出目录。 相对路径是相对于书的根目录解释的。 如果未指定，它将默认为book.toml中build.build-dir键的值，或为./book。

clean 命令

clean命令用于删除生成的书籍和其他用于构建的文件。

mdbook clean

指定目录

clean 命令可以将目录作为参数用作书籍的根目录而不是当前工作目录。

mdbook clean path/to/book

--dest-dir

--dest-dir (-d) 选项允许您更改书籍的输出目录。 相对路径是相对于书的根目录解释的。 如果未指定，它将默认为book.toml 中 build.build-dir 键的值，或为 ./book。

mdbook clean --dest-dir=path/to/book

path/to/book 可以是绝对路径或相对路径。

格式

在本节中，您将学习如何：

  • 正确地组织你的书
  • 格式化你的SUMMARY.md文件
  • 使用book.toml配置你的书
  • 自定义您的主题

SUMMARY.md

mdBook使用摘要文件来了解要包含哪些章节、它们应该以什么顺序出现、它们的层次结构是什么以及源文件在哪里。 没有这个文件，就没有书。 这个markdown文件必须命名为SUMMARY.md。 它的格式非常严格，必须遵循下面概述的结构，以便于解析。 下面未指定的任何元素，无论是格式还是文本，最多可能会被忽略，或者在尝试构建书籍时可能会导致错误。

结构

  1. 标题 - 然是可选的，但通常以标题开头，通常是# Summary. 然而，这被解析器忽略，并且可以省略。

    # Summary

  2. 章节前缀 - 在主要编号章节之前，可以添加不编号的前缀章节。 这对于前言、介绍等很有用。但是，有一些限制。 章节前缀不能嵌套； 它们都应该在根级别。 一旦添加了编号的章节，就无法添加章节前缀。

    [A Prefix Chapter](relative/path/to/markdown.md)

- [First Chapter](relative/path/to/markdown2.md)

  3. 部分标题 - 标题可用作以下编号章节的标题。 这可用于在逻辑上分隔本书的不同部分。 标题呈现为不可点击的文本。 标题是可选的，编号的章节可以根据需要分成任意多个部分。

    # My Part Title

- [First Chapter](relative/path/to/markdown.md)

  4. 章节编号 - 章节编号概述了本书的主要内容，并且可以嵌套，从而形成一个很好的层次结构（如章节、子章节等）

    # Title of Part

- [First Chapter](relative/path/to/markdown.md)
- [Second Chapter](relative/path/to/markdown2.md)
   - [Sub Chapter](relative/path/to/markdown3.md)

# Title of Another Part

- [Another Chapter](relative/path/to/markdown4.md)

    章节编号可以用-或*表示（不要混合分隔符）。

  5. 章节后缀 - 与章节前缀一样，章节后缀是无编号的，但它们位于已编号的章节之后。

    - [Last Chapter](relative/path/to/markdown.md)

[Title of Suffix Chapter](relative/path/to/markdown2.md)

  6. 章节草稿 - 章节草稿是没有文件和内容的章节。 一章草稿的目的是表明未来仍有待编写的章节。 或者当您仍在对书的结构进行布局以避免创建文件时，你仍在大量更改书的结构。 章节草稿将在HTML 呈现器中呈现为目录中的禁用链接，您可以在左侧目录中的下一章节中看到。 章节草稿像普通章节一样编写，但不写入文件路径。

    - [Draft Chapter]()

  7. 分隔符 - 可以在任何其他元素之前、之间和之后添加分隔符。 它们会在构建的目录中生成 HTML 渲染行。 分隔符是仅包含破折号和至少三个破折号的行: ---.

    # My Part Title

[A Prefix Chapter](relative/path/to/markdown.md)

---

- [First Chapter](relative/path/to/markdown2.md)

样例

下面是本指南的SUMMARY.md的markdown文件源，结果目录呈现在左侧。

# Summar

[简介](README.md)

# 用户指南
---

- [安装](guide/installation.md)
- [阅读说明](guide/reading.md)
- [创建](guide/creating.md)

# 参考指南
---

- [命令行](cli/README.md)
  - [init](cli/init.md)
  - [build](cli/build.md)
  - [watch](cli/watch.md)
  - [serve](cli/serve.md)
  - [test](cli/test.md)
  - [clean](cli/clean.md)
- [格式](format/README.md)
  - [SUMMARY.md](format/summary.md)
  - [配置](format/configuration/README.md)
    - [常规配置](format/configuration/general.md)
    - [预处理器](format/configuration/preprocessors.md)
    - [渲染](format/configuration/renderers.md)
    - [环境变量](format/configuration/environment-variables.md)
  - [主题](format/theme/README.md)
    - [index.hbs](format/theme/index-hbs.md)
    - [语法高亮](format/theme/syntax-highlighting.md)
    - [编辑器](format/theme/editor.md)
  - [数学公式](format/mathjax.md)
  - [mdBook特性](format/mdbook.md)
  - [Markdown语法](format/markdown.md)
- [持续集成](continuous-integration.md)
- [开发人员特性](for_developers/README.md)
  - [预处理器](for_developers/preprocessors.md)
  - [后端替代](for_developers/backends.md)
- [贡献列表](misc/contributors.md)

配置

本节详细介绍了book.toml中可用的配置选项：

  • 常规配置包括 book、rust、build 部分
  • 预处理器 配置默认和自定义预处理器.
  • 渲染器 配置HTML，Markdown 和 自定义渲染器。
  • 环境变量 配置用于覆盖默认环境变量中的配置选项。

常规配置

您可以在book.toml文件中为您的书配置参数。

下面是一个book.toml文件的示例：

[book]
title = "Example book"
author = "John Doe"
description = "The example book covers examples."

[rust]
edition = "2018"

[build]
build-dir = "my-example-book"
create-missing = false

[preprocessor.index]

[preprocessor.links]

[output.html]
additional-css = ["custom.css"]

[output.html.search]
limit-results = 15

支持的配置选项

需要注意的是，配置中指定的任何相对路径将始终相对于配置文件所在的书籍的根目录。

常规元配置

这是关于您的书的常规信息。

  • title: 书名
  • authors: 本书的作者
  • description: 这本书的描述，作为元信息添加到每个页面的html<head>中
  • src: 默认情况下，源目录位于根文件夹下名src的目录中。 但这可以使用配置文件中的src键进行配置。
  • language: 本书的主要语言，例如用作语言属性 <html lang="en"> .

book.toml

[book]
title = "Example book"
authors = ["John Doe", "Jane Doe"]
description = "The example book covers examples."
src = "my-src"  # the source files will be found in `root/my-src` instead of `root/src`
language = "en"

Rust 选项

Rust 语言的选项，与运行测试和运行环境集成相关。

  • edition: 默认情况下用于代码片段的 Rust 版本。 默认值为“2015”。 可以使用edition2015、edition2018或edition2021注释来控制单个代码块，例如:

    ```rust,edition2015
// This only works in 2015.
let try = true;
```

Build 选项

这控制着书的构建过程。

  • build-dir: 放置渲染书籍的目录。默认情况下，这是书籍根目录中的book/。

  • create-missing: 默认情况下，在构建本书时将创建在 SUMMARY.md中指定的任何缺失文件（即create-missing = true） 如果值是false，那么如果任何文件不存在，构建过程将改为退出并显示错误。

  • use-default-preprocessors: 通过将此选项设置为false来禁用（links 和index）默认的预处理器。

    如果您通过其配置表声明了相同的和/或其他预处理器，它们将替换默认的预处理运行。

    • 为清楚起见，在没有预处理器配置的情况下，将运行默认的 links 和 index.
    • 设置 use-default-preprocessors = false 将禁止这些默认预处理器运行。
    • 例如添加 [preprocessor.links], 将确保无论use-default-preprocessors 如何都将运行 links。

预处理器配置

默认情况下，预处理器包含一下配置：

  • links: 处理器助手将展开一章中的 {{ #playground }}, {{ #include }}, 和 {{ #rustdoc_include }} 并包含文件里面的内容.
  • index: 将所有名为README.md 的章节文件转换为index.md。 也就是说，所有的README.md都会被渲染到渲染的书中的一个索引文件index.html中。

book.toml

[build]
build-dir = "build"
create-missing = false

[preprocessor.links]

[preprocessor.index]

自定义预处理器配置

像渲染器一样，预处理器需要有自己的表（例如[preprocessor.mathjax]）。

在该部分中，您可以通过向表中添加键值对来将额外的配置传递给预处理器。

例如：

[preprocessor.links]
# set the renderers this preprocessor will run for
renderers = ["html"]
some_extra_feature = true

将预处理器依赖项锁定到渲染器

您可以通过将两者绑定在一起来明确指定应该为渲染器运行预处理器。.

[preprocessor.mathjax]
renderers = ["html"]  # mathjax only makes sense with the HTML renderer

提供您自己的命令

默认情况下，当您将[preprocessor.foo]表添加到book.toml文件时，mdbook将尝试调用mdbook-foo可执行文件。 如果要使用不同的程序名称或传递命令行参数，可以通过添加command字段来覆盖此行为。

[preprocessor.random]
command = "python random.py"

需要一定的顺序

预处理器的运行顺序可以通过before和after字段来控制。

例如，假设你希望你的linenos预处理器 处理可能已经被 {{#include}}包含过的行； 然后你希望它在内置的links 预处理器之后运行，你可以要求使用 before 或 after字段：

[preprocessor.linenos]
after = [ "links" ]

或者

[preprocessor.links]
before = [ "linenos" ]

也可以在同一个配置文件中指定以上两个，虽然是多余的。

通过 before 和 after 指定的具有相同优先级的预处理器按名称排序。 任何无限循环都将被检测到并产生错误。

渲染配置

HTML渲染选项

HTML 渲染器也有几个选项。 渲染器的所有选项都需要在 TOML 表 [output.html]下指定。 以下配置选项可用：

  • theme: mdBook 带有一个默认主题和它所需的所有资源文件。 但是如果设置了这个选项，mdBook 将有选择性地用在指定文件夹中找到主题文件并覆盖默认主题文件
  • default-theme: 在“更改主题”下拉菜单中默认选择的主题配色方案。 默认为light.
  • preferred-dark-theme: 默认的深色主题。 如果浏览器通过'prefers-color-scheme'CSS 媒体查询请求网站的深色版本，则将使用此主题。 默认为navy。
  • curly-quotes: 将直引号转换为卷引号，但出现在代码块和代码跨度中的引号除外。 默认为false。
  • mathjax-support: A添加对 MathJax的支持。 默认为false。
  • copy-fonts: 将 fonts.css 和相应的字体文件复制到输出目录并在默认主题中使用它们。默认为true。
  • google-analytics: 此字段已被弃用，并将在未来版本中删除。 使用theme/head.hbs文件添加适当的谷歌分析代码。
  • additional-css: 如果您需要在不覆盖整个样式的情况下稍微更改书籍的外观，您可以指定一组样式表，这些样式表将在默认样式表之后加载，您可以在其中更改样式。
  • additional-js: 如果您需要在不删除当前行为的情况下向书中添加一些行为，您可以指定一组 JavaScript 文件，这些文件将与默认文件一起加载。
  • print: 配置打印选项的子表。 默认情况下，mdBook 添加了对将书籍打印为单页的支持。 这可以使用书右上角的打印图标访问
  • no-section-label: mdBook 默认在目录列中添加节标签。 例如，“1.”、“2.1”。 将此选项设置为 true 以禁用这些标签。 默认为false。
  • fold: 用于配置侧边栏部分折叠行为的子表。
  • playground: 用于配置各种运行环境设置的子表。
  • search: 用于配置浏览器内搜索功能的子表。 mdBook 必须在启用search(搜索)功能的情况下编译（默认情况下启用）。
  • git-repository-url: 该书的git仓库的url。 如果提供了图标链接，将在书的菜单栏中输出。
  • git-repository-icon: 用于 git 仓库链接的 FontAwesome 图标类。 默认为fa-github。
  • edit-url-template: 编辑 url 模板，当提供时显示“建议编辑”按钮，用于直接跳转到编辑当前查看的页面。 例如 GitHub 项目将此设置为 https://github.com/<owner>/<repo>/edit/master/{path} 或对于 Bitbucket 项目将其设置为 https://bitbucket.org/<owner>/<repo>/src/master/{path}?mode=edit 其中 {path}将替换为仓库中文件的完整路径。
  • redirect: 用于生成重定向到已迁移页面的子表。 该表包含键值对，其中键是需要创建重定向的文件位置，以相对于构建目录的绝对路径表示，（例如 /appendices/bibliography.html) 。 该值可以是浏览器应导航到的任何有效 URI（例如 https://rust-lang.org/, /overview.html, or ../bibliography.html)。
  • input-404: 用于丢失文件的 Markdown 文件的名称。 相应的输出文件将相同，扩展名替换为html. 默认为 404.md.
  • site-url: 将托管图书的网址。 这是确保 404 文件中的导航链接和 脚本/css 导入正常工作所必需的，即使在访问子目录中的 url 时也是如此。 默认为 /。 T
  • cname: 将托管您的图书的 DNS 子域或顶级域。 根据 GitHub Pages 的要求，此字符串将写入站点根目录中名为 CNAME 的文件 (请参阅 Managing a custom domain for your GitHub Pages site).

[output.html.print] 表的可用配置选项：

  • enable: 启用打印支持。 当为false时，将不会呈现所有打印支持。 默认为true。

[output.html.fold] 表的可用配置选项:

  • enable: 启用部分折叠。 关闭时，所有折叠都打开。 默认为false.
  • level: 越高折叠区域越开放。 当 level 为 0 时，所有折叠都关闭。 默认为0.

[output.html.playground] 表的可用配置选项:

  • editable: 允许编辑源代码。 默认为 false.
  • copyable: 在代码片段上显示复制按钮。 默认为true.
  • copy-js: 将编辑器的 JavaScript 文件复制到输出目录。默认为 true.
  • line-numbers 在可编辑的代码部分显示行号。 editable和copy-js 都必须设置为 true. 默认为 false.

[output.html.search]表的可用配置选项:

  • enable: 启用搜索功能。 默认为 true.
  • limit-results: 搜索结果的最大数量。 默认为30.
  • teaser-word-count: T用于搜索结果预览的字数。 默认为 30.
  • use-boolean-and: 定义多个搜索词之间的逻辑链接。 如果为 true，则所有搜索词都必须出现在每个结果中。 默认为 false.
  • boost-title: 如果搜索词出现在标题中，则搜索结果分数的提升因子。 默认为 2.
  • boost-hierarchy: 如果搜索词出现在层次结构中，则搜索结果分数的提升因子。 层次结构包含父文档的所有标题和所有父标题。 默认为 1.
  • boost-paragraph: 如果搜索词出现在文本中，则搜索结果分数的提升因子。 默认为 1.
  • expand: T如果搜索应该匹配更长的结果，则为真，例如 搜索micro 应该匹配microwave。默认为true.
  • heading-split-level: 搜索结果将链接到包含结果的文档部分。 文档按此级别或更低级别的标题分成多个部分。 默认为3.
  • copy-js: 将搜索实现的 JavaScript 文件复制到输出目录。 默认为true.

这显示了 book.toml 中所有可用的 HTML 输出选项：

[book]
title = "Example book"
authors = ["John Doe", "Jane Doe"]
description = "The example book covers examples."

[output.html]
theme = "my-theme"
default-theme = "light"
preferred-dark-theme = "navy"
curly-quotes = true
mathjax-support = false
copy-fonts = true
additional-css = ["custom.css", "custom2.css"]
additional-js = ["custom.js"]
no-section-label = false
git-repository-url = "https://github.com/rust-lang/mdBook"
git-repository-icon = "fa-github"
edit-url-template = "https://github.com/rust-lang/mdBook/edit/master/guide/{path}"
site-url = "/example-book/"
cname = "myproject.rs"
input-404 = "not-found.md"

[output.html.print]
enable = true

[output.html.fold]
enable = false
level = 0

[output.html.playground]
editable = false
copy-js = true
line-numbers = false

[output.html.search]
enable = true
limit-results = 30
teaser-word-count = 30
use-boolean-and = true
boost-title = 2
boost-hierarchy = 1
boost-paragraph = 1
expand = true
heading-split-level = 3
copy-js = true

[output.html.redirect]
"/appendices/bibliography.html" = "https://rustc-dev-guide.rust-lang.org/appendix/bibliography.html"
"/other-installation-methods.html" = "../infra/other-installation-methods.html"

Markdown 渲染

Markdown渲染器 将运行预处理器，然后持续输出Markdown解析结果 。 这对于调试预处理器非常有用，尤其是与mdbook test结合使用以查看mdbook传递给rustdoc的 Markdown文本。 Markdown渲染器 包含在mdboo 中，但默认情况下禁用。 通过向book.toml添加一个空表来启用它，如下所示：

[output.markdown]

Markdown渲染器 目前没有配置选项； 仅是启用还是禁用。

请参阅 预处理器 了解如何指定哪些预处理器应在 Markdown 渲染器之前运行。

用户自定义渲染

可以通过将 [output.foo] 表添加到book.toml来启用自定义渲染器。.与预处理器类似， 这将指示 mdbook 将书的表示传递给mdbook-foo 以进行渲染。 有关更多详细信息，请参阅后端替代一章。

自定义渲染器可以访问其表中的所有字段（即[output.foo] 下的任何内容）。 mdBook 检查两个常见字段：

  • command: 自定义渲染器执行的命令。 默认为带有 mdbook- 前缀的渲染器名称（例如 mdbook-foo）。
  • optional: 如果为true，则如果未安装该命令将被忽略，否则 mdBook 将失败并显示错误。 默认为false。

环境变量

通过设置相应的环境变量，可以从命令行覆盖所有配置值。 由于许多操作系统将环境变量限制为字母数字字符或 _，因此配置键的格式需要与正常的foo.bar.baz格式略有不同。

以MDBOOK_开头的变量用于配置。 密钥是通过删除MDBOOK_前缀并将结果字符串转换为 kebab-case 来创建的。 双下划线 (__) 分隔为嵌套键(.)，而单个下划线 (_) 则替换为破折号 (-)。

例子:

  • MDBOOK_foo -> foo
  • MDBOOK_FOO -> foo
  • MDBOOK_FOO__BAR -> foo.bar
  • MDBOOK_FOO_BAR -> foo-bar
  • MDBOOK_FOO_bar__baz -> foo-bar.baz

因此，通过设置MDBOOK_BOOK__TITLE环境变量，您可以覆盖书名而无需修改您的book.toml。

备注: : 为了方便设置更复杂的配置项，环境变量的值首先被解析为 JSON，如果解析失败则回退到字符串。 这意味着，如果您愿意，您可以在构建书籍时覆盖所有书籍元数据，例如

$ export MDBOOK_BOOK="{'title': 'My Awesome Book', authors: ['Michael-F-Bryan']}"
$ mdbook build

后一种情况在从脚本或 CI 调用mdbook的情况下可能很有用，适用情况为，有时无法在构建之前更新book.toml。

主题

默认渲染器使用一个 handlebars模板来渲染你的markdown文件，并带有一个包含在 mdBook 二进制文件中的默认主题.

主题是完全可定制的，您可以通过在项目根目录的src文件夹旁边添加一个theme目录，有选择地替换主题中的每个文件。 使用要覆盖的文件的名称创建一个新文件，现在将使用该文件而不是默认文件。

以下是您可以覆盖的文件：

  • index.hbs handlebars 模板.
  • head.hbs 附加到 HTML<head>部分。
  • header.hbs 内容附加在每个书页的顶部
  • css/ 包含用于设计样式的 CSS 文件
    • css/chrome.css 用于 UI 元素.
    • css/general.css 是基本样式.
    • css/print.css 是打印机输出的样式.
    • css/variables.css 包含在其他 CSS 文件中使用的变量.
  • book.js 主要用于添加客户端功能，例如隐藏/取消隐藏侧边栏，更改主题，...
  • highlight.js 是用于突出显示代码片段的 JavaScript，您不需要修改它。
  • highlight.css 是用于代码突出显示的主题。
  • favicon.svg 和 favicon.png 使用的图标。 SVG 版本由较新的浏览器使用。

通常，当您想要调整主题时，您不需要覆盖所有文件。 如果您只需要更改样式表，则覆盖所有其他文件没有意义。 因为自定义文件优先于内置文件，所以它们不会随着新的修复程序/功能而更新。

注意: 覆盖文件时，可能会破坏某些功能。 因此，我建议使用默认主题中的文件作为模板，并且只添加/修改您需要的内容。 您可以使用mdbook init --theme自动将默认主题复制到源目录中，然后删除不想覆盖的文件。

如果完全替换所有内置主题，请务必在配置中设置output.html.preferred-dark-theme，默认为内置navy 主题。

index.hbs

index.hbs 是用于渲染book的handlebars模板。 Markdown 文件被处理为 html，然后注入到该模板中。 如果您想更改书籍的布局或样式，您可能需要稍微修改此模板。 本节是您需要了解的内容。

Data

许多数据通过context(上下文)暴露给handlebars模板。 在handlebars模板中，您可以使用这些数据。

{{name_of_property}}

以下是公开的属性列表：

  • language 书的语言采用en形式，如book.toml中指定（如果未指定，默认为en）。 例如在 <html lang="{{ language }}"> 中使用。

  • title 用于当前页面的标题。 这与 {{chapter_title }} - {{ book_title }} 相同，除非没有设置book_title，在这种情况下它只是默认为chapter_title。

  • book_title 书名，在book.toml中指定。

  • chapter_title 当前章节的标题，如SUMMARY.md中所列.

  • path 从源目录到原始Markdown文件的相对路径

  • content 这是渲染过的Markdown.

  • path_to_root 这是一个只包含 ../ 的路径，它指向根目录。 由于保留了原始目录结构，因此使用此 path_to_root 预先添加相关链接很有用.

  • chapters 是一个形式为字典的数组

    {"section": "1.2.1", "name": "name of this chapter", "path": "dir/markdown.md"}

    包含本书的所有章节。 例如，它用于构建目录（侧边栏）。

Handlebars Helpers

除了您可以访问的属性外，还有一些handlebars helpers可供您使用。

1. toc

toc helper 是这样使用的

{{#toc}}{{/toc}}

并输出看起来像这样的东西，这取决于你的书的结构

<ul class="chapter">
    <li><a href="link/to/file.html">Some chapter</a></li>
    <li>
        <ul class="section">
            <li><a href="link/to/other_file.html">Some other Chapter</a></li>
        </ul>
    </li>
</ul>

如果你想用另一种结构制作目录，你可以访问包含所有数据的章节属性。 目前唯一的限制是您必须使用 JavaScript 而不是使用handlebars helpers来完成。

<script>
var chapters = {{chapters}};
// Processing here
</script>

2. previous / next

previous和next 的helpers公开了指向前一章和下一章的link(链接)和name(名称)属性。

它们是这样使用的

{{#previous}}
    <a href="{{link}}" class="nav-chapters previous">
        <i class="fa fa-angle-left"></i>
    </a>
{{/previous}}

仅在上一章/下一章存在时才会渲染 inner html。 当然，可以根据自己的喜好更改 inner html。

如果您想公开其他属性或helpers，请创建一个创建一个新issue

语法高亮

mdBook 使用具有自定义主题的Highlight.js 来突出显示语法。

自动语言检测已关闭，因此您可能希望像这样指定您使用的编程语言：

```rust
fn main() {
    // Some code
}
```

支持的编程语言

默认情况下支持这些语言，但您可以通过提供自己的highlight.js文件来添加更多语言：

  • apache
  • armasm
  • bash
  • c
  • coffeescript
  • cpp
  • csharp
  • css
  • d
  • diff
  • go
  • handlebars
  • haskell
  • http
  • ini
  • java
  • javascript
  • json
  • julia
  • kotlin
  • less
  • lua
  • makefile
  • markdown
  • nginx
  • objectivec
  • perl
  • php
  • plaintext
  • properties
  • python
  • r
  • ruby
  • rust
  • scala
  • scss
  • shell
  • sql
  • swift
  • typescript
  • x86asm
  • xml
  • yaml

用户主题

与主题的其余部分一样，用于语法突出显示的文件可以用您自己的文件覆盖。

  • highlight.js 通常您不必覆盖此文件，除非您想使用更新的版本。
  • highlight.css highlight.js 用于语法高亮显示的主题。

如果你想为highlight.js使用另一个主题，请从他们的网站下载它，或者自己制作，将其重命名为 highlight.css 并将其放在你的书的theme文件夹中。

现在将使用您的主题而不是默认主题。

隐藏代码行

mdBook 中有一项功能可以让您通过在代码行前加上#来隐藏代码行。

# fn main() {
    let x = 5;
    let y = 6;

    println!("{}", x + y);
# }

将渲染为

fn main() {
    let x = 5;
    let y = 7;

    println!("{}", x + y);
}

目前，这只适用于使用rust注释的代码示例。 因为它会与某些编程语言的语义发生冲突。 将来，我们希望通过book.toml使其可配置，以便每个人都可以从中受益。

改进默认主题

如果您认为默认主题对于特定语言来说看起来不太合适，或者可以改进，请随时 提交一个新issue来解释您的想法，我会查看它。 您还可以创建pull-request来建议需要改进的地方。

总体而言，主题应该是轻松而清醒的，没有太多华丽的色彩。

编辑器

除了提供可运行的代码环境外，mdBook还允许它们可编辑。 为了启用可编辑的代码块，需要在 book.toml 中添加以下内容：

[output.html.playground]
editable = true

要使特定块可用于编辑，需要向其添加属性editable：

```rust,editable
fn main() {
    let number = 5;
    print!("{}", number);
}
```

以上将导致这个可编辑和运行的代码块：

fn main() {
    let number = 5;
    print!("{}", number);
}

请注意代码块中的 撤销更改 按钮。

自定义编辑器

默认情况下，编辑器是 Ace 编辑器，但如果需要，可以通过提供不同的文件夹来覆盖该功能：

[output.html.playground]
editable = true
editor = "/path/to/editor"

请注意，为了使编辑器更改正常运行，需要覆盖 theme 文件夹内的book.js，因为它与默认的Ace编辑器有一些耦合。

数学公式支持

mdBook 通过MathJax选择性地支持数学方程式。

要启用 MathJax，您需要在book.toml部分下的 book.toml 中添加mathjax-support键。

[output.html]
mathjax-support = true

注意: 尚不支持 MathJax 使用的常用分隔符。 您目前不能使用 $$ ... $$ 作为分隔符，并且 \[ ... \] 分隔符需要额外的反斜杠才能工作。 希望这个限制很快就会解除。

注意: 当您在 MathJax 块中使用双反斜杠（例如\begin{cases} \frac 1 2 \\ \frac 3 4 \end{cases}等命令中）时， 您需要添加两个额外的反斜杠（例如，\begin>{cases} \frac 1 2 \\\\ \frac 3 4 \end{cases})。

内联方程式

内联方程由 \\( and \\)分隔。 例如，要渲染以下内联方程 \( \int x dx = \frac{x^2}{2} + C \) ，您可以编写以下内容：

\\( \int x dx = \frac{x^2}{2} + C \\)

块方程式

块方程由 \\[ 和 \\].分隔。 渲染以下等式 \[ \mu = \frac{1}{N} \sum_{i=0} x_i \]

你会写：

\\[ \mu = \frac{1}{N} \sum_{i=0} x_i \\]

mdBook特性

隐藏代码行

mdBook 中有一个功能可以让你通过在代码行前面加上#来隐藏代码行，就像你在 Rustdoc 中所做的那样。

# fn main() {
    let x = 5;
    let y = 6;

    println!("{}", x + y);
# }

会渲染成

fn main() {
    let x = 5;
    let y = 6;

    println!("{}", x + y);
}

包含文件

使用以下语法，您可以将文件包含到您的书中：

{{#include file.rs}}

文件路径必须相对于当前源文件。

mdBook 会将包含的文件解释为 Markdown。 由于 include 命令通常用于插入代码片段和示例，因此您通常会用 ``` 包裹该命令以显示文件内容而不解释它们。

```
{{#include file.rs}}
```

包含文件的一部分

通常您只需要文件的特定部分，例如 相关行举例。 我们支持四种不同的部分模式包括：

{{#include file.rs:2}}
{{#include file.rs::10}}
{{#include file.rs:2:}}
{{#include file.rs:2:10}}

第一个命令只包含文件 file.rs 的第二行。 第二个命令包括到第 10 行的所有行，即从 11 到文件末尾的行被省略。 第三个命令包括第 2 行的所有行，即省略第一行。 最后一个命令包括 file.rs的摘录，由第 2 行到第 10 行组成。

为了避免在修改包含的文件时破坏您的书籍，您还可以使用锚点而不是行号来包含特定部分。 锚点是一对匹配的线。 锚点开始的行必须与正则表达式 ANCHOR:\s*[\w_-]+ 匹配，类似地， 结束行必须与正则表达式 ANCHOR_END:\s*[\w_-]+ 匹配。 这允许您在任何类型的注释行中放置锚点。

考虑包含以下文件：

/* ANCHOR: all */

// ANCHOR: component
struct Paddle {
    hello: f32,
}
// ANCHOR_END: component

////////// ANCHOR: system
impl System for MySystem { ... }
////////// ANCHOR_END: system

/* ANCHOR_END: all */

然后在书中，你所要做的就是：

Here is a component:
```rust,no_run,noplayground
{{#include file.rs:component}}
```

Here is a system:
```rust,no_run,noplayground
{{#include file.rs:system}}
```

This is the full file.
```rust,no_run,noplayground
{{#include file.rs:all}}
```

包含在锚点内的锚点匹配模式的行将被忽略。

包含一个文件，但隐藏最初指定行之外的所有内容

rustdoc_include用于包含来自外部 Rust 文件的代码，这些文件包含完整的示例，但最初仅以与include相同的方式显示用行号或锚点指定的特定行。

不在行号范围内或锚点之间的行仍将包含在内，但它们将以#开头。 这样，读者可以展开代码片段以查看完整示例，而 Rustdoc 将在您运行mdbook test时使用完整示例。

例如，考虑一个名为 file.rs 的文件，其中包含这个 Rust 程序：

fn main() {
    let x = add_one(2);
    assert_eq!(x, 3);
}

fn add_one(num: i32) -> i32 {
    num + 1
}

我们可以使用以下语法包含一个最初仅显示第 2 行的代码段：

调用 `add_one` 函数, 我们传入一个 `i32` 并且将返回值赋值给 `x`:
```rust
{{#rustdoc_include file.rs:2}}
```

这与我们手动插入代码并使用#隐藏除第 2 行之外的所有代码具有相同的效果：

调用 `add_one` 函数, 我们传入一个 `i32` 并且将返回值赋值给 `x`:
```rust
# fn main() {
    let x = add_one(2);
#     assert_eq!(x, 3);
# }
#
# fn add_one(num: i32) -> i32 {
#     num + 1
# }
```

也就是说，它看起来像这样（单击“expand”图标以查看文件的其余部分）：

fn main() {
    let x = add_one(2);
    assert_eq!(x, 3);
}

fn add_one(num: i32) -> i32 {
    num + 1
}

插入可运行的 Rust 文件

使用以下语法，您可以将可运行的 Rust 文件插入到您的书中：

{{#playground file.rs}}

Rust 文件的路径必须相对于当前源文件。

当点击 play 时，代码片段将被发送到 Rust Playground进行编译和运行。 结果被送回并直接显示在代码下方。

下面是渲染的代码片段的样子：

fn main() {
    println!("Hello World!");

    // You can even hide lines! :D
    println!("I am hidden! Expand the code snippet to see me");
}

控制页面 <title>

通过在页面顶部附近包含一个{{#title ...}}，章节可以设置一个<title> ，该<title> 与其在目录（侧边栏）中的条目不同。

{{#title My Title}}

Markdown

mdBook 的解析器遵循CommonMark规范。 您可以学习快速教程，或实时试用 CommonMark。 完整的 Markdown 概述超出了本文档的范围，但以下是一些基础知识的高级概述。 如需更深入的体验，请查看 Markdown 指南。

文本和段落

文本渲染相对可预测：

Here is a line of text.

This is a new line.

看起来像您期望的那样：

Here is a line of text.

This is a new line.

标题

标题使用#标记并且应该单独在一行上。 更多#意味着更小的标题：

### A heading 

Some text.

#### A smaller heading 

More text.

一个标题

Some text.

一个更小的标题

More text.

列表

列表可以是无序或有序的。 有序列表将自动排序：

* milk
* eggs
* butter

1. carrots
1. celery
1. radishes
  • milk
  • eggs
  • butter
  1. carrots
  2. celery
  3. radishes

链接

链接到 URL 或本地文件很容易：

Use [mdBook](https://github.com/rust-lang/mdBook). 

Read about [mdBook](mdBook.md).

A bare url: <https://www.rust-lang.org>.

Use mdBook.

Read about mdBook.

A bare url: https://www.rust-lang.org.

图片

包含图像只是包含指向它们的链接的问题，就像上面的 链接 部分一样。 以下 markdown 包含在与此文件相同级别的 images 目录中找到的 Rust 徽标的 SVG 图像：

![The Rust Logo](images/rust-logo-blk.svg)

使用 mdBook 构建时生成以下 HTML：

<p><img src="images/rust-logo-blk.svg" alt="The Rust Logo" /></p>

其中，当然显示图像如下：

The Rust Logo

有关更多信息，请参阅 Markdown 指南基本语法文档。

在持续集成中运行 mdbook

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

下面提供了一些关于如何配置服务以运行mdBook的一般指南。

可以在[Automatic Deployment]wiki页面上找到具体的方法。

安装mdBook

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

预编译的二进制文件

也许最简单的方法是使用GitHub发布页面上的预编译二进制文件。

一种简单的方法是使用流行的curl工具下载可执行文件

mkdir bin
curl -sSL https://github.com/rust-lang/mdBook/releases/download/v0.4.22/mdbook-v0.4.22-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的最新non-breaking版本。

例如：

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之后的版本将不会安装，因为它们可能会破坏您的构建。如果您已经安装了旧版本，Cargo将自动升级mdBook.
  • --locked — 他将使用mdBook发布时使用的依赖项。 Without --locked, it will use the latest version of all dependencies, which may include some fixes since the last release, but may also (rarely) cause build problems.

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

运行测试

每次推送更改或创建拉取请求时，您可能希望使用mdbook test运行测试。

这可以用来验证书中的Rust代码示例。

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

除了确保安装了适当版本的Rust之外，除了从数据目录运行mdbook test 之外，没有什么其他的事情。

您可能还想考虑运行其他类型的测试，如mdbook-linkcheck，它将检查断开的链接。或者，如果您有自己的样式检查、拼写检查或任何其他测试，最好在CI中运行它们。

部署

您可能希望自动部署书本。 有些人可能希望在每次推送更改时都这样做，而另一些人可能希望仅在标记特定版本时进行部署。

您还需要了解如何将更改推送到web服务的细节。例如GitHub Pages只需要将输出提交到特定的git分支。其他服务可能需要使用SSH之类的东西来连接到远程服务器。

基本要点是，您需要运行 mdbook build来生成输出，然后将文件（位于“book”目录中）传输到正确的位置。

然后，您可能需要考虑是否需要使web服务上的任何缓存无效。

有关各种不同服务的示例，请参见[自动部署]wiki页面。

处理404

mdBook自动生成一个404页面，用于链接不存在的时候。 默认输出是位于书本根目录的名为404.html的文件。 一些服务（如GitHub Pages）将自动返回此页面查当url不存在时。 对于其他服务，您可能需要考虑将web服务器配置为使用此页面，因为它将为读者提供返回书本的导航。 如果您的书没有部署在域的根目录下，那么您应该设置[output.html.siteurl]设置，以便404页面正常工作。

它需要知道书的部署位置，以便正确加载静态文件（如CSS）。 例如，本指南部署在https://rust-lang.github.io/mdBook/，并且site-url设置配置如下：

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

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

开发者

虽然 mdbook 主要用作命令行工具，但您也可以直接导入底层库并使用它来管理书籍。 它还具有相当灵活的插件机制，如果您需要对本书进行一些分析或以不同的格式呈现它，则允许您创建自己的自定义工具和使用者（通常称为后端）。

开发者章节在这里向您展示mdbook的更高级用法。

开发人员可以通过两种主要方式与本书的构建过程挂钩,

构建过程

渲染书籍项目的过程需要经过几个步骤

  1. 加载 book
    • 解析 book.toml, 如果不存在，则回退到默认的 Config
    • 加载 book 章节到内存
    • 发现应该使用哪些预处理器/后端
  2. 运行预处理器
  3. 依次调用各个后端

使用 mdbook 作为库

mdbook二进制文件只是mdbookcrate 的包装器，将其功能作为命令行程序公开。 因此，很容易创建自己的程序，在内部使用mdbook，添加自己的功能（例如自定义预处理器）或调整构建过程。

了解如何使用 mdbookcrate 的最简单方法是查看API文档。 顶级文档解释了如何使用MDBook类型加载和构建一本书，而config模块对配置系统给出了很好的解释。

预处理器

预处理器只是一小段代码，它在书籍加载后和渲染之前立即运行，允许您更新和修改书籍。 可能的用例是

  • 创建一个自定义 helpers 例如 {{#include /path/to/file.md}}
  • 更新链接，以便HTML渲染器渲染时将 [some chapter](some_chapter.md) i自动更改为 [some chapter](some_chapter.html)
  • 替换 latex 风格的表达式 ($$ \frac{1}{3} $$) 为 等价的 mathjax 表达式

连接到 MDBook

MDBook 使用一种相当简单的机制来发现第三方插件。 一个新表被添加到 book.toml（例如foo预处理器的preprocessor.foo）， 然后mdbook将尝试调用mdbook-foo程序作为构建过程的一部分。

预处理器可以硬编码来指定preprocessor.foo.renderer键, 指定他应该运行那些后端。 例如将MathJax用于非 HTML 渲染器是没有意义的。

[book]
title = "My Book"
authors = ["Michael-F-Bryan"]

[preprocessor.foo]
# The command can also be specified manually
command = "python3 /path/to/foo.py"
# Only run the `foo` preprocessor for the HTML and EPUB renderer
renderer = ["html", "epub"]

一旦定义了预处理器并开始构建过程，mdBook 将执行preprocessor.foo.command键中定义的命令两次。

它第一次运行为预处理器确定它是否支持给定的渲染器。

mdBook 向进程传递两个参数：第一个参数是字符串supports，第二个参数是渲染器名称。

如果预处理器支持给定的渲染器，则它应该以状态代码 0 退出，如果不支持，则返回非零退出代码。

如果预处理器支持渲染器，则 mdbook 将第二次运行它，且将 JSON 数据传递到 stdin。 JSON 包含一个[context, book] 数组，其中 context 是序列化的对象 PreprocessorContext，而 book 是包含书籍内容的 Book 对象。

预处理器应该将 Book对象的 JSON 格式返回到标准输出，并带有它希望执行的任何修改。

最简单的入门方法是创建您自己的 Preprocessortrait 实现（例如在 lib.rs中）， 然后创建一个 shell 二进制文件，将输入转换为正确的 Preprocessor 方法。 为方便起见，examples/目录中有一个示例 no-op 预处理器，它可以很容易地适用于其他预处理器。

Example no-op preprocessor 
// nop-preprocessors.rs

use crate::nop_lib::Nop;
use clap::{App, Arg, ArgMatches, SubCommand};
use mdbook::book::Book;
use mdbook::errors::Error;
use mdbook::preprocess::{CmdPreprocessor, Preprocessor, PreprocessorContext};
use semver::{Version, VersionReq};
use std::io;
use std::process;

pub fn make_app() -> App<'static, 'static> {
    App::new("nop-preprocessor")
        .about("A mdbook preprocessor which does precisely nothing")
        .subcommand(
            SubCommand::with_name("supports")
                .arg(Arg::with_name("renderer").required(true))
                .about("Check whether a renderer is supported by this preprocessor"),
        )
}

fn main() {
    let matches = make_app().get_matches();

    // Users will want to construct their own preprocessor here
    let preprocessor = Nop::new();

    if let Some(sub_args) = matches.subcommand_matches("supports") {
        handle_supports(&preprocessor, sub_args);
    } else if let Err(e) = handle_preprocessing(&preprocessor) {
        eprintln!("{}", e);
        process::exit(1);
    }
}

fn handle_preprocessing(pre: &dyn Preprocessor) -> Result<(), Error> {
    let (ctx, book) = CmdPreprocessor::parse_input(io::stdin())?;

    let book_version = Version::parse(&ctx.mdbook_version)?;
    let version_req = VersionReq::parse(mdbook::MDBOOK_VERSION)?;

    if !version_req.matches(&book_version) {
        eprintln!(
            "Warning: The {} plugin was built against version {} of mdbook, \
             but we're being called from version {}",
            pre.name(),
            mdbook::MDBOOK_VERSION,
            ctx.mdbook_version
        );
    }

    let processed_book = pre.run(&ctx, book)?;
    serde_json::to_writer(io::stdout(), &processed_book)?;

    Ok(())
}

fn handle_supports(pre: &dyn Preprocessor, sub_args: &ArgMatches) -> ! {
    let renderer = sub_args.value_of("renderer").expect("Required argument");
    let supported = pre.supports_renderer(renderer);

    // Signal whether the renderer is supported by exiting with 1 or 0.
    if supported {
        process::exit(0);
    } else {
        process::exit(1);
    }
}

/// The actual implementation of the `Nop` preprocessor. This would usually go
/// in your main `lib.rs` file.
mod nop_lib {
    use super::*;

    /// A no-op preprocessor.
    pub struct Nop;

    impl Nop {
        pub fn new() -> Nop {
            Nop
        }
    }

    impl Preprocessor for Nop {
        fn name(&self) -> &str {
            "nop-preprocessor"
        }

        fn run(&self, ctx: &PreprocessorContext, book: Book) -> Result<Book, Error> {
            // In testing we want to tell the preprocessor to blow up by setting a
            // particular config value
            if let Some(nop_cfg) = ctx.config.get_preprocessor(self.name()) {
                if nop_cfg.contains_key("blow-up") {
                    anyhow::bail!("Boom!!1!");
                }
            }

            // we *are* a no-op preprocessor after all
            Ok(book)
        }

        fn supports_renderer(&self, renderer: &str) -> bool {
            renderer != "not-supported"
        }
    }
}

实现预处理器的提示

通过将mdbook作为库引入，预处理器可以访问现有的基础架构来处理书籍。

例如，自定义预处理器可以使用CmdPreprocessor::parse_input()函数反序列化写入stdin的 JSON。 然后可以通过 Book::for_each_mut()就地修改 Book 的每一章，然后使用 serde_json crate 写入stdout 。

Chapters can be accessed either directly (by recursively iterating over chapters) or via the Book::for_each_mut() convenience method.

章节可以直接访问（通过递归迭代章节）或通过Book::for_each_mut() 便捷方法访问。

该 chapter.content只是一个字符串，恰好是 Markdown。 虽然完全可以使用正则表达式或进行手动查找和替换，但您可能希望将输入处理为对计算机更友好的内容。 pulldown-cmark crate 实现了一个生产质量的基于事件的 Markdown 解析器，使用 pulldown-cmark-to-cmark允许您将事件转换回 Markdown 文本。

以下代码块显示了如何从 Markdown 中删除所有强调，而不会意外破坏文档。

#![allow(unused)]
fn main() {
fn remove_emphasis(
    num_removed_items: &mut usize,
    chapter: &mut Chapter,
) -> Result<String> {
    let mut buf = String::with_capacity(chapter.content.len());

    let events = Parser::new(&chapter.content).filter(|e| {
        let should_keep = match *e {
            Event::Start(Tag::Emphasis)
            | Event::Start(Tag::Strong)
            | Event::End(Tag::Emphasis)
            | Event::End(Tag::Strong) => false,
            _ => true,
        };
        if !should_keep {
            *num_removed_items += 1;
        }
        should_keep
    });

    cmark(events, &mut buf, None).map(|_| buf).map_err(|err| {
        Error::from(format!("Markdown serialization failed: {}", err))
    })
}
}

对于其他所有内容，请查看完整示例example。

用不同的语言实现预处理器

mdBook 利用 stdin 和 stdout 与预处理器通信的事实使得用 Rust 以外的语言实现它们变得容易。

下面的代码展示了如何在Python中实现一个简单的预处理器，将修改第一章的内容。

下面的示例遵循上面显示的配置，其中preprocessor.foo.command实际上指向一个 Python 脚本。

import json
import sys


if __name__ == '__main__':
    if len(sys.argv) > 1: # we check if we received any argument
        if sys.argv[1] == "supports": 
            # then we are good to return an exit status code of 0, since the other argument will just be the renderer's name
            sys.exit(0)

    # load both the context and the book representations from stdin
    context, book = json.load(sys.stdin)
    # and now, we can just modify the content of the first chapter
    book['sections'][0]['Chapter']['content'] = '# Hello'
    # we are done with the book's modification, we can just print it to stdout, 
    print(json.dumps(book))

后端替换

后端只是一个 mdbook 在渲染过程中调用的程序。 该程序通过stdin传递书籍和配置信息的JSON表示。 一旦后端收到此信息，它就可以自由地做任何想做的事

GitHub 上已经有几个替代后端，可以用作在实践中如何完成的大概示例

  • mdbook-linkcheck - 一个用于验证这本书不包含任何损坏的链接的简单程序
  • mdbook-epub - 一个 EPUB 渲染器
  • mdbook-test - 一个通过[rust-skeptic运行本书内容的程序，以验证所有内容是否正确编译和运行（类似于 rustdoc --test）
  • mdbook-man - 从书中生成手册页

此页面将引导您以简单的字数统计程序的形式创建您自己的替代后端。 虽然它将用Rust编写，但没有理由不能使用 Python 或 Ruby 之类的其他编程语言来完成

起步

首先，您需要创建一个新的二进制程序并添加mdbook作为依赖项。

$ cargo new --bin mdbook-wordcount
$ cd mdbook-wordcount
$ cargo add mdbook

当我们的 mdbook-wordcount 插件被调用时，mdbook将通过我们插件的 stdin向它发送 RenderContext 的 JSON 版本。 为方便起见，有一个RenderContext::from_json() 构造函数，它将加载一个RenderContext。

这是我们的后端加载本书所需的所有样板。

// src/main.rs
extern crate mdbook;

use std::io;
use mdbook::renderer::RenderContext;

fn main() {
    let mut stdin = io::stdin();
    let ctx = RenderContext::from_json(&mut stdin).unwrap();
}

Note: 注意: RenderContext 包含一个version字段。 这让后端可以确定它们是否与它正在调用的mdbook版本兼容。 该version直接来自mdbook 的Cargo.toml中的相应字段。

建议后端使用 semver crate 检查此字段，并在可能存在兼容性问题时发出警告。

核查 Book

现在我们的后端有这本书的副本，让我们数一数每章有多少字！

因为RenderContext 包含一个Book字段（book），并且Book具有Book::iter()方法来迭代Book中的所有项目，这一步 结果证明和第一个一样容易。


fn main() {
    let mut stdin = io::stdin();
    let ctx = RenderContext::from_json(&mut stdin).unwrap();

    for item in ctx.book.iter() {
        if let BookItem::Chapter(ref ch) = *item {
            let num_words = count_words(ch);
            println!("{}: {}", ch.name, num_words);
        }
    }
}

fn count_words(ch: &Chapter) -> usize {
    ch.content.split_whitespace().count()
}

启用后端

现在我们已经有了基础运行代码，我们想要实际使用它。 首先，安装程序。

$ cargo install --path .

然后cd 到你想要计算单词数的特定书籍目录. 并更新它的book.toml 文件。

  [book]
  title = "mdBook Documentation"
  description = "Create book from markdown files. Like Gitbook but implemented in Rust"
  authors = ["Mathieu David", "Michael-F-Bryan"]

+ [output.html]

+ [output.wordcount]

当它将一本书加载到内存中时，mdbook 将检查您的 book.toml文件，以通过查找所有output.*表来尝试找出要使用的后端。 如果没有提供，它将回退到使用默认的 HTML 渲染器。

值得注意的是，这意味着如果您想添加自己的自定义后端，您还需要确保添加 HTML 后端，即使它的表只是为空。

现在你只需要像往常一样构建你的书，一切都应该正常工作。

$ mdbook build
...
2018-01-16 07:31:15 [INFO] (mdbook::renderer): Invoking the "mdbook-wordcount" renderer
mdBook: 126
Command Line Tool: 224
init: 283
build: 145
watch: 146
serve: 292
test: 139
Format: 30
SUMMARY.md: 259
Configuration: 784
Theme: 304
index.hbs: 447
Syntax highlighting: 314
MathJax Support: 153
Rust code specific features: 148
For Developers: 788
Alternative Backends: 710
Contributors: 85

我们不需要指定 wordcount 后端的全名/路径的原因是因为 mdbook 将尝试通过约定推断程序的名称。 foo 后端的可执行文件通常称为mdbook-foo，在book.toml中有一个关联的 [output.foo] 条目。 要明确告诉mdbook 调用什么命令（它可能需要命令行参数或解释脚本），您可以使用command字段。

  [book]
  title = "mdBook Documentation"
  description = "Create book from markdown files. Like Gitbook but implemented in Rust"
  authors = ["Mathieu David", "Michael-F-Bryan"]

  [output.html]

  [output.wordcount]
+ command = "python /path/to/wordcount.py"

配置

现在假设您不想计算特定章节的字数（它可能是生成的文本/代码等）。 执行此操作的规范方法是通过配置文件book.toml ， 将项目添加到配置文件的 [output.foo]表中。

Config 可以粗略地视为一个嵌套的 hashmap， 它允许您调用get()之类的方法来访问配置的内容，使用get_deserialized()便捷方法检索值并自动反序列化为某个任意类型T。

为了实现这一点，我们将创建我们自己的可序列化 WordcountConfig 结构，它将封装此后端的所有配置。

首先将serde和 serde_derive 添加到 Cargo.toml,

$ cargo add serde serde_derive

然后你可以创建配置结构，

#![allow(unused)]
fn main() {
extern crate serde;
#[macro_use]
extern crate serde_derive;

...

#[derive(Debug, Default, Serialize, Deserialize)]
#[serde(default, rename_all = "kebab-case")]
pub struct WordcountConfig {
  pub ignores: Vec<String>,
}
}

现在我们只需要从我们的 RenderContext反序列化WordcountConfig，然后添加一个检查以确保跳过被我们忽略的章节。

  fn main() {
      let mut stdin = io::stdin();
      let ctx = RenderContext::from_json(&mut stdin).unwrap();
+     let cfg: WordcountConfig = ctx.config
+         .get_deserialized("output.wordcount")
+         .unwrap_or_default();

      for item in ctx.book.iter() {
          if let BookItem::Chapter(ref ch) = *item {
+             if cfg.ignores.contains(&ch.name) {
+                 continue;
+             }
+
              let num_words = count_words(ch);
              println!("{}: {}", ch.name, num_words);
          }
      }
  }

输出和信令故障

虽然在构建一本书时将字数打印到终端是很好的，但将它们输出到某个文件中也可能是一个好主意。 mdbook告诉后端它应该通过RenderContext中的destination字段将任何生成的输出放置在哪里。

+ use std::fs::{self, File};
+ use std::io::{self, Write};
- use std::io;
  use mdbook::renderer::RenderContext;
  use mdbook::book::{BookItem, Chapter};

  fn main() {
    ...

+     let _ = fs::create_dir_all(&ctx.destination);
+     let mut f = File::create(ctx.destination.join("wordcounts.txt")).unwrap();
+
      for item in ctx.book.iter() {
          if let BookItem::Chapter(ref ch) = *item {
              ...

              let num_words = count_words(ch);
              println!("{}: {}", ch.name, num_words);
+             writeln!(f, "{}: {}", ch.name, num_words).unwrap();
          }
      }
  }

Note: 无法保证目标目录存在或为空（mdbook可能会保留之前的内容让后端进行缓存），因此使用 fs::create_dir_all() 创建它总是一个好主意。 如果目标目录已经存在，不要假设它是空的。 为了允许后端缓存先前运行的结果，mdbook可能会在目录中保留旧内容。

处理书籍时总是有可能发生错误（只需查看我们已经编写的所有 unwrap() ），因此 mdbook 会将非零退出代码解释为渲染失败。

例如如果我们想确保所有章节都有偶数个单词，如果遇到奇数就出错，那么你可以这样做：

+ use std::process;
  ...

  fn main() {
      ...

      for item in ctx.book.iter() {
          if let BookItem::Chapter(ref ch) = *item {
              ...

              let num_words = count_words(ch);
              println!("{}: {}", ch.name, num_words);
              writeln!(f, "{}: {}", ch.name, num_words).unwrap();

+             if cfg.deny_odds && num_words % 2 == 1 {
+               eprintln!("{} has an odd number of words!", ch.name);
+               process::exit(1);
              }
          }
      }
  }

  #[derive(Debug, Default, Serialize, Deserialize)]
  #[serde(default, rename_all = "kebab-case")]
  pub struct WordcountConfig {
      pub ignores: Vec<String>,
+     pub deny_odds: bool,
  }

现在，如果我们重新安装后端并构建一本书，

$ cargo install --path . --force
$ mdbook build /path/to/book
...
2018-01-16 21:21:39 [INFO] (mdbook::renderer): Invoking the "wordcount" renderer
mdBook: 126
Command Line Tool: 224
init: 283
init has an odd number of words!
2018-01-16 21:21:39 [ERROR] (mdbook::renderer): Renderer exited with non-zero return code.
2018-01-16 21:21:39 [ERROR] (mdbook::utils): Error: Rendering failed
2018-01-16 21:21:39 [ERROR] (mdbook::utils):    Caused By: The "mdbook-wordcount" renderer failed

您可能已经注意到，插件子进程的输出会立即传递给用户。 鼓励插件遵循“沉默规则”，仅在必要时生成输出（例如生成错误或警告）。

所有环境变量都传递到后端，允许您使用通常的RUST_LOG来控制日志记录的详细程度。

处理缺失的后端

如果启用未安装的后端，默认行为是抛出错误：

The command `mdbook-wordcount` wasn't found, is the "wordcount" backend installed?
If you want to ignore this error when the "wordcount" backend is not installed,
set `optional = true` in the `[output.wordcount]` section of the book.toml configuration file.

可以通过将后端标记为可选来更改此行为。

  [book]
  title = "mdBook Documentation"
  description = "Create book from markdown files. Like Gitbook but implemented in Rust"
  authors = ["Mathieu David", "Michael-F-Bryan"]

  [output.html]

  [output.wordcount]
  command = "python /path/to/wordcount.py"
+ optional = true

这会将错误降级为警告，而是如下所示：

The command was not found, but was marked as optional.
    Command: wordcount

总结

虽然人为设计，但希望这个例子足以展示您如何为mdbook创建后端替换。 如果您觉得缺少某些内容，请不要犹豫在issue tracker中创建问题，以便我们改进用户指南。 本章开头提到的现有后端应该作为它在现实生活中如何完成的一个很好的例子，所以请随意浏览源代码或提出问题。

贡献者

以下是帮助改进 mdBook 的贡献者列表。 向他们欢呼！

如果您觉得自己不在此列表中，请随时将自己添加到仓库中。