mdbook-linkcheck
A backend for mdBook that automatically checks links in documentation for validity.
What is mdbook-linkcheck?
mdbook-linkcheck is a backend plugin for mdBook, the documentation tool from the Rust ecosystem. It automatically scans and validates both internal and external links within documentation projects to identify broken links before publication, helping maintain documentation quality and reliability.
Technical writers and developers using mdBook to create and maintain documentation, particularly those integrating documentation checks into CI/CD pipelines.
Developers choose mdbook-linkcheck for its seamless integration with mdBook, configurable link validation with caching to reduce network overhead, and the ability to enforce link integrity as part of automated workflows.
Overview
A backend for mdbook which will check your links for you.
Use Cases
Best For
- Automatically checking for broken links in mdBook documentation projects during local builds.
- Integrating link validation into continuous integration (CI) pipelines to catch issues before deployment.
Related Projects
Found a gem we're missing?
Open-Awesome is built by the community, for the community. Submit a project, suggest an awesome list, or help improve the catalog on GitHub.
