Check for broken links in markup files. Currently html and markdown files are supported. The Markup Link Checker can easily be integrated in your CI/CD pipeline to prevent broken links in your markup docs.
There are different ways to install and use mlc.
Use rust's package manager cargo to install mlc from crates.io:
bash
cargo install mlc
To download a compiled binary version of mlc go to github releases and download the binaries compiled for x86_64-unknown-linux-gnu.
To integrate mlc in your CI pipeline running in a linux x86_64 environment you can add the following commands to download mlc:
bash
curl -L https://github.com/becheran/mlc/releases/download/v0.9.0/mlc -o mlc
chmod +x mlc
For example take a look at the ntest repo which uses mlc in the CI pipeline.
Once you have mlc installed it canned just be called from the command line. The following call will check all links in markup files found in the current folder and all subdirectories:
bash
mlc
Another example would be to call mlc on a certain directory or file:
bash
mlc ./docs
Call mlc with the --help flag to display all available cli arguments:
bash
mlc -h
See the reference for all available command line arguments.
Checkout the changelog file to see the changes between different versions.
All contributions and comments welcome! Open an issue or create a Pull Request whenever you find a bug or have an idea to improve this crate.
This project is licensed under the MIT License - see the LICENSE file for details.