【每周一库】 mdbook - a CLI tool and Rust rate to create books

本期的每周一库带来的是一个基于rust的markdown文件生成类似gitbook风格的工具

库的相关链接

• mdbook, official website
• mkdbook, crates.io

从官网的介绍来看，mdbook和gitbook风格非常类似，只不过用了rust来实现。下面我们来试用一下mdbook。

测试环境

• Windows 10
• cargo --version: cargo 1.50.0 (f04e7fab7 2021-02-04)
• rustc --version: rustc 1.50.0 (cb75ad5db 2021-02-10)

可以通过多种方式安装mdbook这里通过crates.io进行安装

cargo install mdbook

安装完成之后创建mdbook工程，类似于gitbook的使用，假设我们创建的mdbook工程名为hello-mdbook

mdbook init hello-mdbook

创建完成之后的目录结构如下

接下来可以使用build命令来创建完整版本book

mdbook build

监听本地文件变化并重新渲染可以使用命令

mdbook watch

本地浏览器预览可以使用命令

mdbook serve

serve命令下可以在浏览器中预览效果

接下来是一个比较厉害的功能，很多时候我们需要在markdown中插入代码，mdbook提供了测试markdown中代码块的功能。

如果我们写入如下代码块

然后运行命令

mdbook test

运行结果如下

如果我们的代码块有错误，那么运行mdbook test结果如下

如果我们想ignore某些代码块的测试，可以在markdown的代码块标签后加ignore备注，如下图

综合试用下来，基于rust开发的mdbook在动态刷新和使用体验上非常优秀，不失为替代gitbook的一个选择。 以上就是本期每周一库的内容。