cargo-deadlinks •

检查您的 cargo doc 文档中的断链！

如果您刚刚重构了您的 crate 结构，或者想确保文档可离线阅读，这将非常有用。

此 crate 与 文档内链接 和 cargo-intraconv 一起使用效果更好，它们使得在不了解 rustdoc 将生成的确切 HTML 页面的情况下编写链接变得更容易。

deadlinks 也可以用于非 Rust crate 的项目。

安装

通过以下命令安装 cargo-deadlinks：

cargo install cargo-deadlinks

或者，从 发布页面 安装预编译的二进制文件。

用法

在您的包目录中运行以下命令：

# this will automatically run `cargo doc` for you
# any broken links will show up in the output
cargo deadlinks
# if you also want to check http and https links
cargo deadlinks --check-http

默认情况下，cargo deadlinks 将只检查您的包的离线（file://）链接。

如果您想检查另一个目录中的文档，例如检查所有依赖项，可以提供 --dir 参数

cargo deadlinks --dir target/doc

要检查非 crate 的项目，请使用 deadlinks

# this requires that you already have a static site in build/html
deadlinks build/html

关于其他参数的信息，请运行cargo deadlinks --help。

支持的 Rust 版本最低 (MSRV)

当前的 MSRV 是 1.45.0。这可能在次要版本中增加，但永远不会在补丁版本中增加。

贡献

我们欢迎任何贡献！

要开始，您可以查看我们的Github 事务。

除非您明确声明，否则任何有意提交以包含在您的工作中的贡献，如 Apache-2.0 许可证中定义的，将按以下方式双许可，而不附加任何额外条款或条件。

许可证

许可以下之一

• Apache 许可证第 2 版 (LICENSE-APACHE 或 https://apache.ac.cn/licenses/LICENSE-2.0)
• MIT 许可证 (LICENSE-MIT 或 https://open-source.org.cn/licenses/MIT)

任选其一。