mdBook用于使用Markdown创建在线书籍。 它是创建产品或API文档，教程，课程材料或任何需要场景的md在线文档， 方便于导航和可定制的演示文稿，mdBook是一个命令行工具，mdBook是免费和开源的 ，源代码就在GitHub 上可以下载构建。mdBook是对标GitBook的，喜欢写markdown文档、书籍的朋友们应该都知道GitBook，用来写电子书非常实用，mdBook也是可以做到的，mdBook的官方文档就是用它来搭建的，非常强大。

mdBook特点（译文）

1.轻量级， Markdown 语法可帮助您更专注于内容

2.支持搜索

3.各种不同语言的代码块的语法高亮不同颜色显示

4.主题文件允许自定义输出的格式

5.预处理器可以为自定义语法和修改内容提供扩展

6.后端可以将输出呈现为多种格式

7.用 Rust 语言编写，以提高速度、安全性和简单性

8.自动测试 Rust 代码示例

在线读书

介绍一下如何与mdBook制作的书籍进行交互。 这假设您正在阅读一本 HTML 书籍。 对于其他输出格式（如 PDF），选项和格式将有所不同。

一本书被组织成章节。 每一章都是一个单独的页面。 章节可以嵌套到子章节的层次结构中。 通常，每章将组织成一系列标题以细分一章。

导航

有几种方法可以浏览一本书的章节。

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

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

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

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

顶部菜单栏

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

描述

打开和关闭章节列表侧边栏。

打开选取器以选择不同的颜色主题。

打开搜索栏以在图书中进行搜索。

指示 Web 浏览器打印整本书。

打开指向承载图书源代码的网站的链接。

打开一个页面以直接编辑您当前正在阅读的页面的源代码。

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

搜索

每本书都有一个内置的搜索系统。 按菜单栏中的搜索图标 ， 或按键盘上的键将打开一个输入框，用于输入搜索词。 键入一些术语将实时显示匹配的章节和部分。

单击任何结果将跳转到该部分。 向上和向下箭头键可用于导航结果，回车键将打开突出显示的部分。

加载搜索结果后，匹配的搜索词将在文本中突出显示。 单击突出显示的单词或按键将删除突出显示。

代码块

mdBook 书籍通常用于编程项目，因此支持突出显示代码块和示例。 代码块可能包含几个用于与它们交互的不同图标：

描述

将代码块复制到本地剪贴板，以允许粘贴到另一个应用程序中。

对于 Rust 代码示例，这将执行示例代码并在示例下方显示编译器输出。

对于 Rust 代码示例，这将切换“隐藏”行的可见性。有时，较大的示例会隐藏与所说明内容不特别相关的行（请参阅隐藏代码行）。

对于可编辑的代码示例，这将撤消您所做的任何更改。

下面是一个示例：

println!("Hello, World!");

mdBook CLI安装

这里安装的是mdbook的脚手架，这个脚手架就是用来创建在线文档书籍的。有多种方法可以安装 mdBook CLI 工具， 选择以下最适合您需求的任何一种方法。

1、预编译的二进制文件

可执行二进制文件可在 GitHub 发布页面上下载。 下载适用于您的平台（Windows、macOS 或 Linux）的二进制文件并解压缩存档。 存档包含一个可执行文件，您可以运行它来构建您的书籍。mdbook

为了使其更易于运行，请将二进制文件的路径放入 .PATH

2、使用 Rust 从源代码构建

要从源代码构建可执行文件，您首先需要安装 Rust 和 Cargo。 按照 Rust 安装页面上的说明进行操作。 mdBook 目前至少需要 Rust 1.60 版本。mdbook

安装 Rust 后，可以使用以下命令来构建和安装 mdBook：

cargo install mdbook

这将自动从 crates.io 下载mdBook，构建它，并将其安装在Cargo的全局二进制目录中（默认情况下）。~/.cargo/bin/

要卸载，请运行命令 。cargo uninstall mdbook

Windows安装示例

1、在GitHub上下载mdbook-v0.4.28-x86_64-pc-windows-msvc.zip二进制文件，解压放到目录：D:\mdbook，把这个目录添加到环境变量PATH里。

2、打开cmd窗口，进入到上面的目录D:\mdbook，

输入命令：mdbook.exe运行mdbook.exe。

3、初始化init

4、构建

构建完成后，生成了一个book目录

5、输入mdbook serve命令运行mdbook

6、输入就可以看到在线书籍的界面了

主题颜色

有5个主题颜色可以选择。

完成命令

完成命令用于为一些常见的 shell 生成自动完成。 这意味着当您键入 shell 时，您可以按 shell 的自动完成键（通常是 Tab 键），它可能会显示有效选项是什么，或者完成部分输入：mdbook

首先需要为您的 shell 安装完备：

mdbook completions bash > ~/.local/share/bash-completion/completions/mdbook

该命令打印给定外壳的完成脚本。 运行以获取支持的外壳列表。mdbook completions --help

完成的放置位置取决于您使用的 shell 和操作系统。 有关详细信息，请参阅 shell 的文档，了解将脚本放置在何处。

mdBook特定功能

mdBook有非常多很特别的功能，对rust开发者很有帮助，这里列几点，更多功能大家可以到官网查看哦！

隐藏代码行

mdBook 中有一个功能，可让您通过添加前缀来隐藏代码行 就像你对 Rustdoc 一样。 这目前仅适用于 Rust 语言代码块。#

# fn main() {    let x = 5;    let y = 6;    println!("{}", x + y);# }

将呈现为

    let x = 5;    let y = 6;    println!("{}", x + y);

代码块有一个“眼球图标”，它将切换隐藏线的可见性。

包括文件

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

{{#include file.rs}}

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

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

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

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

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

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

更多功能，大家自己去发现吧！