Skip to content
<awesome-gh-repos>
vic

deadlinks/cargo-deadlinks

Cargo subcommand for checking your documentation for broken links
Source code at GitHub https://github.com/deadlinks/cargo-deadlinks
deadlinks/cargo-deadlinks.json
{
  "createdAt": "2016-03-25T16:26:44Z",
  "defaultBranch": "master",
  "description": "Cargo subcommand for checking your documentation for broken links",
  "fullName": "deadlinks/cargo-deadlinks",
  "homepage": "",
  "language": "Rust",
  "name": "cargo-deadlinks",
  "pushedAt": "2024-12-10T14:14:12Z",
  "stargazersCount": 155,
  "topics": [
    "cargo-subcommand",
    "linter"
  ],
  "updatedAt": "2025-09-27T04:46:45Z",
  "url": "https://github.com/deadlinks/cargo-deadlinks"
}

cargo-deadlinks • Crates.io License

Section titled “cargo-deadlinks • ”

Check your cargo doc documentation for broken links!

Useful if you just refactored the structure of your crate or want to ensure that your documentation is readable offline.

This crate pairs well with [intra-doc links] and [cargo-intraconv], which make it easier to write links without having to know the exact HTML page rustdoc will generate.

deadlinks can also be used on projects that aren’t Rust crates.

Installation

Section titled “Installation”

Install cargo-deadlinks via:

Terminal window
cargo install cargo-deadlinks

Alternatively, install pre-built binaries from the [releases page].

[intra-doc links] !: https://doc.rust-lang.org/rustdoc/linking-to-items-by-name.html [cargo-intraconv] !: https://github.com/poliorcetics/cargo-intraconv [releases page] !: https://github.com/deadlinks/cargo-deadlinks/releases

Usage

Section titled “Usage”

From your packages directory run:

Terminal window
# 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

By default cargo deadlinks will check only the offline (file://) links of your package.

If you want to check the documentation in another directory e.g. to check all your dependencies, you can provide the --dir argument:

Terminal window
cargo deadlinks --dir target/doc

To check a project that isn’t a crate, use deadlinks instead:

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

For information about other arguments run cargo deadlinks --help.

Minimum Supported Rust Version (MSRV)

Section titled “Minimum Supported Rust Version (MSRV)”

The current MSRV is 1.45.0. This may be increased in minor versions, but will never increase in a patch version.

Contributing

Section titled “Contributing”

We are happy about any contributions!

To get started you can take a look at our Github issues.

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as below, without any additional terms or conditions.

License

Section titled “License”

Licensed under either of

at your option.