注释

这是 mdbook document 的非官方中文翻译版本，根据mdBook document(official) GitHub 版本 0.4.18 翻译

简介

mdBook是一个通过Markdown制作图书的命令行工具软件。它非常适合创建产品说明或API文档、教程、课程教材或任何需要清晰、易于导航和可定制的演示文稿。

• 轻量级的Markdown语法帮助你聚焦写作
• 集成的搜索功能支持
• 支持多种编程语言代码块的语法高亮
• 主题文件允许自定义输出的格式
• 预处理能够为自定义语法和内容修改提供扩展
• 后端可以将输出多种格式文件
• 由高效、安全、简单的Rust语言编写
• 自动对Rust代码示例进行测试

本指南就是由 mdBook 生成的一个示例。同时mdBook也被Rust语言项目使用，而 The Rust Programming Language 这本书也是mdBook生成的另一个很好的示例。

贡献

mdBook是免费的开源的。您可以在 GitHub找到源代码，同时您也可以将问题和功能请求发布在 GitHub issue tracker。mdBook 依靠社区来修复错误和 添加功能：如果您想做出贡献，请阅读 CONTRIBUTE 指南，并考虑是否提交一个 拉取请求。

许可协议

mdBook 源代码及文档基于 Mozilla Public License v2.0发布.