前面，我们已经介绍过很多的文档构建工具，比如Docsify、、、等等。今天我们来介绍一款号称是GitBook替代者的文档构件工具，它就是。
MdBook是一款使用Rust开发的文档构建工具，它特别轻量，不依赖开发环境，仅仅一个可执行文件就能完成文档构建。而且构建出的文档网站具备代高亮、本地搜索、markdown渲染等功能。
2.1、获取MdBook
我们从MdBook的页面去根据操作系统下载我们需要的软件包即可。
下载解压后，就可以得到mdbook.exe，我们在mdbook.exe所在路径下直接使用mdbook.exe即可进行项目创建和开发了。
2.2、创建项目
我们可以对当前目录进行初始化，也能指定文件夹进行初始化。
创建项目命令：
2.3、项目结构
以上，book是mdbook帮我们构建完的静态工程，book.toml是项目的配置文件，src才是原始的md文档。
我们向src中增加一个目录，然后向其中添加一个md文件，启动mdbook的开发服务器查看效果。
2.4、预览文档
命令：
如上，mdbook构建的文档和gitbook还是非常相似的。
2.5、自定义侧边栏
mdbook的侧边栏是在项目根目录下的SUMMARY.md中定义的， 我们只需要将我们自己开发的文档在SUMMARY.md中进行配置，即可实现侧边栏导航。
SUMMARY.md
文档结构
预览效果
mdbook支持配置SUMMARY.md自动生成文件，非常适合预先构建文档结构的场景。
经过简单的使用体验，我们可以发现mdbook构建文档是非常的简单，但是它也存在一些问题。
新兴项目能做到这样已经很不错了，期待mdbook越来越好。
版权声明：本文内容由互联网用户自发贡献，该文观点仅代表作者本人。本站仅提供信息存储空间服务，不拥有所有权，不承担相关法律责任。如发现本站有涉嫌侵权/违法违规的内容，请联系我们，一经查实，本站将立刻删除。
如需转载请保留出处：https://51itzy.com/kjqy/142317.html