mdBook 文档

简介

mdBook 是一个使用 Markdown 创建书籍的命令行工具。它非常适合创建产品或 API 文档、教程、课程材料，或任何需要简洁、易于导航和可定制演示的内容。

• 轻量级 Markdown 语法帮助您更专注于内容
• 集成搜索支持
• 为多种编程语言的代码块提供彩色语法高亮
• 主题文件允许自定义输出格式
• 预处理器可为自定义语法和内容修改提供扩展
• 后端可以将输出渲染为多种格式
• 使用 Rust 编写，具有速度快、安全性高和简洁的特点
• 自动测试 Rust 代码示例

本指南就是 mdBook 生成内容的一个示例。mdBook 被 Rust 编程语言项目所使用，《Rust 程序设计语言》这本书是 mdBook 实际应用的另一个优秀范例。

贡献

mdBook 是免费且开源的。您可以在 GitHub 上找到源代码，问题和功能请求可以发布在 GitHub 问题跟踪器上。mdBook 依赖社区来修复错误和添加功能：如果您想做出贡献，请阅读 CONTRIBUTING 指南，并考虑发起一个拉取请求。

许可证

mdBook 的源代码和文档根据 Mozilla Public License v2.0 发布。