Broken Markdown Links
This repository is an utility written in Rust that ensures all links in a Markdown file are valid, by ensuring the target files exist.
It also ensures that for links pointing to a specific header (like [link name](file.md#some-header)
) the said header exists in the target file.
Command-line usage
Check a single file:
broken-md-links input.md
Check a whole directory:
broken-md-links dir/ -r
Output
There are several levels of verbosity:
-v silent
: display nothing (exit code will be 0 if there was no broken link)-v errors
: display errors only-v warn
: display errors and warnings (the default)-v info
: display the list of analyzed files as well-v verbose
: display detailed informations-v trace
: display debug informations
Library usage
use check_broken_links;
License
This project is released under the Apache-2.0 license terms.