文章目录mdBook用 Markdown 写电子书Rust 官方出品mdBook用 Markdown 写电子书Rust 官方出品mdBook 是 Rust 官方开源的一个工具专门用来把 Markdown 文件转换成在线书籍。目前在 GitHub 上有 21k 的 Star。这个工具的设计思路很简单你写好 Markdown 文件它帮你生成一个干净、可阅读的在线文档站点。很多技术文档、教程、手册都是用它来生成的。Rust 官方的《The Rust Programming Language》这本书最早也是用 mdBook 来构建的。功能特点mdBook 的功能围绕写书这个核心需求展开Markdown 驱动所有内容用 Markdown 格式编写学习成本低实时预览支持mdbook serve命令修改文件后浏览器自动刷新代码高亮内置多种编程语言的语法高亮支持搜索功能生成的书籍自带全文搜索主题定制可以自定义 CSS 和模板调整输出样式多语言支持支持国际化可以写多语言版本的书籍插件系统通过 preprocessor 和 backend 插件扩展功能安装方法如果你已经安装了 Rust 环境直接用 cargo 安装cargoinstallmdbook安装完成后用mdbook --version验证是否成功。基本使用创建新书mdbook init my-book这个命令会生成一个标准的目录结构my-book/ ├── book/ ├── src/ │ ├── SUMMARY.md │ └── chapter_1.md └── book.toml其中book.toml是配置文件src/SUMMARY.md定义了书籍的目录结构。预览书籍mdbook serve默认会在本地启动一个 HTTP 服务器打开浏览器访问http://localhost:3000就能看到效果。构建静态文件mdbook build生成的 HTML 文件会保存在book/目录下可以直接部署到任何静态文件服务器。配置说明book.toml是核心配置文件包含书籍的基本信息和构建选项[book] title 我的技术文档 authors [你的名字] language zh [build] build-dir book create-missing true [output.html] default-theme light preferred-dark-theme navy常见的配置项包括主题选择、代码高亮风格、是否启用搜索等。SUMMARY.md 格式目录结构通过src/SUMMARY.md文件定义# 目录 - [前言](./README.md) - [第一章入门](./chapter_1.md) - [1.1 安装](./chapter_1/install.md) - [1.2 配置](./chapter_1/config.md) - [第二章进阶](./chapter_2.md)Markdown 的列表语法直接对应书籍的层级结构缩进表示子章节。实际应用场景mdBook 适合用来写项目文档和 API 参考技术教程和培训材料团队内部知识库个人学习笔记它的输出是纯静态 HTML不需要数据库部署方便可以直接放在 GitHub Pages、Netlify 等平台上。和同类工具对比相比 GitBook、Docusaurus 等工具mdBook 的特点是轻量和专注。它不追求功能大而全而是把写 Markdown 生成书籍这件事做好。如果你的技术栈是 Rust或者你需要一个简单可靠的文档生成工具mdBook 是一个不错的选择。项目使用 Mozilla Public License v2.0 开源可以免费用于商业和非商业项目。rkdown 生成书籍这件事做好。如果你的技术栈是 Rust或者你需要一个简单可靠的文档生成工具mdBook 是一个不错的选择。项目使用 Mozilla Public License v2.0 开源可以免费用于商业和非商业项目。