为什么使用mdBook
需求:
- 想使用 Markdown 的方式编写文档
- 能生成站点
- 能生成 pdf 或 epub
同类对比:
- gitbook 简单易用,node 环境。是 mdBook 的前辈,问题是官方已经不在维护
- mdBook Rust中的Gitbook替代品。
- pandoc 稍复杂一下,功能强大,导入导出支持各种格式,Python 体系
- docsify 简单易用,适合项目文档站点,与GitBook不同,它不会生成静态html文件
- MkDocs 简单易用,Python 体系
- Read the Docs 基于 Sphinx 使用 reStructuredText 格式,非 Markdown ,Python 体系
如何使用mdBook
- 官方文档: https://rust-lang.github.io/mdBook/
- mdBook 中文文档: https://mdbook.budshome.com/index.html
- 第三方插件: https://github.com/rust-lang/mdBook/wiki/Third-party-plugins
依赖 Rust 环境,安装过程官方文档很详细了
遇到的坑:
cargo 下载很慢
- 解决:更换成 USTC 中科大的源
使用第三方插件导出 epub 时,一直报错
解决:https://github.com/Michael-F-Bryan/mdbook-epub/issues/46
使用最新版的mdbook-epub
cargo install --version=0.4.14-alpha.0 mdbook-epub
体会心得
- 上手容易,导出 epub 很方便
- 主题目前比较少,样式不是很好看,虽然可以自己调整