markdown-checker¶
Markdown link validation reporting tool. It provides a couple of functions to validate relative paths and web URLs.
Installation¶
pip install markdown-checker
Requires Python >= 3.11.
New here?¶
Start with the Tutorial: Your First Link Check: install the tool and run it against a small sample project to see exactly what it does.
Have a specific task?¶
The How-to Guides guides cover selecting files, skipping domains/URLs,
configuring via pyproject.toml, tuning rate limits, choosing a report
format, and running in GitHub Actions.
Looking something up?¶
The Reference pages are dry, complete descriptions of every CLI option, what each check flags, configuration keys, report formats, and exit codes.
Want to understand how it works?¶
The Explanation pages cover the URL-checking pipeline and how links are detected and classified.
API Reference¶
If you are looking for information on a specific function, class or method, this part of the documentation is for you.