Mdbook简要教程|GitBook的替代者

介绍

现在有很多的文档构建工具，比如Docsify、Mkdocs、Nikola、Pelican等等。今天我来介绍一款号称是GitBook替代者的文档构建工具，它就是Mdbook。

MdBook是一款使用Rust开发的文档构建工具，它特别轻量，不依赖开发环境，仅仅一个可执行文件就能完成文档构建。而且构建出的文档网站具备代高亮、本地搜索、Markdown渲染等功能。

实践使用

下载/获取

从MdBook的Github release页面去根据操作系统下载我们需要的软件包即可。

下载解压后，就可以得到mdbook.exe，我们在mdbook.exe所在路径下直接调用mdbook.exe即可进行项目创建和开发了。

创建项目

命令

mdbook.exe init ./docs

项目结构

docs/
├── book
├── book.toml
└── src
    ├── chapter_1.md
    └── SUMMARY.md

以上，book是mdbook帮我们构建完的静态工程，book.toml是项目的配置文件，src才是原始的md文档。

我们向src中增加一个目录，然后向其中添加一个md文件，启动mdbook的开发服务器查看效果。

start http://localhost:3000
mdbook.exe serve

serve是启动服务器，默认地址为localhost:3000