In simple English
This tool checks your documentation for broken web links and missing files. It reads Markdown and HTML pages and reports every bad link it finds. You can run it on your own computer or inside your automated build pipeline. It saves you from losing readers to dead pages. It is free and open source.
What it is
Markup Link Checker (mlc) is a command-line tool written in Rust (a programming language known for speed and safety) that verifies links in text documents. It follows local paths and tests live web addresses to make sure they still work.
What it is good for
Anyone who maintains a website, documentation, or a collection of notes in Markdown can catch embarrassing broken links before your readers do.
- Runs very fast thanks to asynchronous Rust code.
- Can check local files without an internet connection using an offline flag.
- Integrates easily into GitHub Actions and other automated workflows.
- Does not check heading anchors inside pages, so a renamed header goes unnoticed.
- Checking hundreds of external web links takes time and can trigger rate limits.
- Requires a command-line interface to install and run.
manual link checking
GitHub Actions
- lycheeverse/lychee4.0k stars
A fast link checker written in Rust that supports Markdown, HTML, and email files.
- tcort/markdown-link-check721 stars
A Node-based command-line tool that scans Markdown files for broken links.
- facebook/docusaurus67k stars
A static site generator from Meta that turns Markdown files into a documentation website.
- mkdocs/mkdocs23k stars
Turns a folder of Markdown files into a documentation website, controlled by one settings file.
- squidfunk/mkdocs-material28k stars
Turns a folder of Markdown files into a searchable documentation website, with every formerly sponsor-only feature now included.
cargo install mlc