这是什么?
mdBook 是一个命令行小工具,能把一个装满 Markdown 文件的文件夹变成一本现代化的在线书——也就是一个可以托管在任何地方的静态网站。可以把它理解成 Gitbook,只不过是用 Rust 写的。
它是像 Gitbook 那样的托管服务,还是我加到自己代码里的库?
都不是——它是一个用 Rust 写的独立开源命令行工具。你在本地对 Markdown 源文件运行它,它来构建成书,不涉及任何托管服务。
怎么安装,怎么创建我的第一本书?
用 Rust 的包管理器从 crates.io 安装:cargo install mdbook。装好后,官方的《用户指南》会带你了解各项功能、使用方法以及如何组织一本书的结构。
我需要会 Rust 或者装特殊的工具链才能用吗?
不需要——你只管写普通的 Markdown,网站由 mdBook 来构建。你唯一需要的是装好 Rust 工具链,这样 cargo 才能下载并编译 mdBook 本身。
它能在哪些平台上运行?
它是一个跨平台的 Rust 命令行工具,可以在 Windows、macOS 和 Linux 上运行;它生成的书就是普通的网页,任何浏览器都能打开阅读。
这个工具以及我用它构建的书,在法律上我能怎么用?
所有代码都基于 Mozilla Public License v2.0 发布——可以自由使用,包括商用,只要对 mdBook 本身所做的修改也按同一许可证共享即可。
装任何东西之前,我能先看看输出效果长什么样吗?
可以——官方的《用户指南》本身就是用 mdBook 构建的,相当于一个现成的演示,能让你看到一本做好的书是什么样子。
这个项目成熟度和人气怎么样?
它是 rust-lang 官方 GitHub 组织下的一个老牌项目,创建于 2015 年,已有超过 22,000 颗星。新版本发布在 crates.io 上,也有面向开发者的《贡献指南》。
What are similar projects?
jsdoc, docusaurus, docz, quarkdown, vibex, buildawesome, mkdocs, fumadocs
Which topics is it in?
technical-documentation, publishing, documentation-generator, docs, documentation-tool, writing, static-site-generator, book, documentation, developers, html, markdown