简介
mdBook 是一个使用Markdown来创建在线书籍的命令行工具。 它非常适合创建产品或API文档、教程、课程材料或任何需要干净、易于导航和可定制的演示文稿。
- 轻量级Markdown语法帮助您更专注于您的内容
- 集成搜索支持
- 语法高亮用于许多不同语言的代码块
- 主题文件允许自定义输出格式
- 预处理器 可以提供自定义语法和修改内容的扩展
- 后端替代 可以将输出呈现为多种格式
- 用 Rust 编写速度快、安全和简单
- Rust 代码示例 的自动化测试
本指南就是由mdBook
生成的示例。
mdBook被Rust
编程语言项目使用,Rust语言官方《rust语言指导》书市mdBook的另一个很好的例子。
贡献代码
mdBook是免费和开源的。 您可以在GitHub上找到源代码. 问题和功能请求可以发布在GitHub 问题跟踪器。 mdBook依靠社区来修复bug和添加新的功能:如果您想贡献代码,请先阅读贡献代码指南,然后他分支,提交PR。
License
mdBook源代码和文档发布于Mozilla Public License v2.0。