Skip to main content

A markdown link validation reporting tool

Project description

PyPi Documentation Status Downloads

GitHub issues Contributing

markdown-checker is a markdown link validation reporting tool. It provides a couple of functions to validate relative paths and web URLs.


Install the package:

pip install markdown-checker


1, 2, 3 - How To

  1. Run pip install markdown-checker.
  2. Run markdown-checker -d {src} -f {func} -gu {url}. Replace {src} with the directory you want to analyze, {func} with the available functions like check_broken_paths, {gu} with your contribution guidance full URL.
  3. The output will be displayed in the terminal and in a file.

Using markdown-checker in GitHub Actions

You can run this tool within a GitHub workflow using the action-check-markdown GitHub action.

The action will automatically post the output of the tool to your GitHub pull request as a comment.


The library provides the following functions:


This function ensures that any relative path in your files are working.


markdown-checker -d . -f check_broken_paths -gu


This function ensures that any web URL in your files is working and returning 200 status code.


markdown-checker -d . -f check_broken_urls -gu


This function checks if country specific locale is present in URLs.


markdown-checker -d . -f check_urls_locale -gu


This function ensures that any relative path has tracking in it.


markdown-checker -d . -f check_paths_tracking -gu


This function ensures that any URL has tracking in it.


markdown-checker -d . -f check_urls_tracking -gu

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

markdown_checker-0.1.4.tar.gz (10.5 kB view hashes)

Uploaded Source

Built Distribution

markdown_checker-0.1.4-py3-none-any.whl (11.1 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page