markdown-checker¶

Markdown link validation reporting tool. It provides a couple of functions to validate relative paths and web URLs.

User’s Guide¶

The user guide is the best place to start if you are new to Markdown Checker. It provides a comprehensive overview of the library, including installation instructions, usage examples, and troubleshooting tips.

Contents

Requirements¶

You will need the following prerequisites in order to use this library:

Python >= 3.10
httpx2
click

Installation¶

pip install markdown-checker

1, 2, 3 - How To¶

Run pip install markdown-checker.
Run markdown-checker -d {src} -f {func} -gu {url}. Replace {src} with the directory you want to analyze, {func} with one of the available functions such as check_broken_paths, and {url} with the full URL to your contribution guide.
The output will be displayed in the terminal and in a comment.md file.

API Reference¶

If you are looking for information on a specific function, class or method, this part of the documentation is for you.

API Reference

Checker
Checks
- Base
- Broken Paths
- Broken URLs
- Locale
- Tracking
CLI
- ListOfStrings
Main
Models
- Base
- Path
- URL
Reports
Utilities