mdBook 工具

这是一个 正在进行中 的项目。命令行界面 (CLI) 和底层 API 可能会更改。最近发布的更改的摘要可以在 RELEASES.md 中找到。您还可以参考 TODO.md。

mdbook-utils 是什么？它有什么用途？

mdbook-utils 命令行工具用于管理大量 Markdown 文件中的 链接、引用定义 和 代码块，尤其是在 mdbook 源目录中。它是 Rust How-to 书籍 (github) 的配套工具。

mdbook-utils 适用于以下用途

• 将所有引用定义集中在一个文件中，使 Markdown 文件更易于阅读并简化链接维护，
• 将简单的 Markdown 链接替换为徽章，
• 识别重复或断开的链接，
• 为您的主页或网站生成一个网站地图文件，
• 将嵌入到 Markdown 中的代码块提取到单独的文件中，以便于格式化、调试和测试，
• 将代码示例替换为 mdBook #include 语句，
• 反之，将 mdBook 包含替换为文件内容。

安装和使用

有关安装和使用的说明，请参阅 用户指南。

公共 API

mdbook-utils 的底层库还公开了一个 公共 API，您可以从您的代码中使用它。

关键链接

mdbook-utils （GitHub） （docs.rs） （crates.io） （用户指南）