Repolode
rust-lang

rust-lang/mdBook

一个用 Rust 编写的命令行工具,可将 Markdown 文件生成为在线书籍,类似 GitBook。

可替代:GitBook

Star
22,236
Fork
1,908
未关闭 Issue
659
最近提交
20小时前

这是什么?

mdBook 可以把一个目录中的 Markdown 文件生成为结构清晰、可导航的在线书籍,适合编写技术文档和较长篇幅的教程。Rust 官方的用户指南本身也是用它构建的。

该项目使用 Rust 编写,可通过 crates.io 安装为单个命令行程序。书籍结构由配置文件和目录(SUMMARY)定义,输出为静态网站,可部署到任意静态文件服务器上。

由于内容就是普通 Markdown 文件,可以像代码一样纳入版本控制,并用任何文本编辑器编辑。项目采用 Mozilla Public License v2.0 许可证。

核心功能

  • 01将 Markdown 源文件构建为静态 HTML 书籍。
  • 02通过目录文件定义书籍的章节结构。
  • 03可通过 crates.io 安装为单个 Rust 命令行程序。
  • 04输出为静态网站,可部署到任意静态文件服务器。

适用场景

  • 发布编程语言或软件库的用户指南。
  • 编写保存在 Git 仓库中的内部工程文档。
  • 将长篇教程或课程笔记制作成可浏览的网站。

使用前须知

  • 采用 MPL-2.0 许可证,这是文件级别的 copyleft 许可证,修改过的源文件必须保持 MPL-2.0 许可。

标签

常见问题

mdBook 是什么?
一个用 Rust 编写的命令行工具,可将 Markdown 文件生成为在线书籍,类似 GitBook。 mdBook 可以把一个目录中的 Markdown 文件生成为结构清晰、可导航的在线书籍,适合编写技术文档和较长篇幅的教程。Rust 官方的用户指南本身也是用它构建的。
mdBook 可以免费使用吗?用的什么许可证?
mdBook 以 MPL-2.0 许可证开源。用于商业产品前,请先确认许可证条款。
mdBook 还在维护吗?
活跃维护中。mdBook 最近一次提交是在 2026年10月21日。
mdBook 适合用来做什么?
发布编程语言或软件库的用户指南。 编写保存在 Git 仓库中的内部工程文档。 将长篇教程或课程笔记制作成可浏览的网站。
在哪里获取 mdBook?
源代码和安装说明在 GitHub 上:https://github.com/rust-lang/mdBook

概要由 AI 根据项目 README 生成;GitHub 数据每日更新。

相关项目