Clippy 书籍
本文档解释了如何对 Clippy 书籍(您现在正在阅读的 Clippy 指南)进行添加和更改。Clippy 书籍使用 Markdown 格式化,并由 mdBook 生成。
获取 mdBook
虽然不是严格必需的,因为书籍的源代码只是 Markdown 文本文件,但在本地拥有 mdBook 将允许您在将更改提交到存储库之前,在本地构建、测试和提供书籍以查看更改。您可能已经安装了 cargo
,所以最简单的选项是
cargo install mdbook
请参阅 mdBook 的 安装 说明以了解其他选项。
进行更改
该书籍的 src 目录包含用于生成书籍的所有 markdown 文件。如果您想实时查看更改,可以使用 mdBook 的 serve
命令在本地运行一个 Web 服务器,该服务器会在更改时自动更新。从您的 rust-clippy
目录的顶层
mdbook serve book --open
然后导航到 https://127.0.0.1:3000
查看生成的书籍。当服务器运行时,您所做的更改将自动更新。
有关更多信息,请参阅 mdBook 指南。