markdown-checker 1.0.1

A markdown link validation reporting tool.

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

Installation

Install the package:

pip install markdown-checker

Documentation

• Full documentation.

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 comment.md file.

For more customizations read the docs.

Note: When using list parameters (like --skip-domains, --skip-files, etc.), provide values as comma-separated without spaces: --skip-domains=example.com,test.com. Do not use square brackets or spaces after commas. See the Advanced Usage documentation for detailed examples.

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.

Usage

The library provides the following functions:

• Usage
  • check_broken_paths
  • check_broken_urls
  • check_urls_locale
  • check_paths_tracking
  • check_urls_tracking

check_broken_paths

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

Example:

markdown-checker -d . -f check_broken_paths -gu https://github.com/john0isaac/markdown-checker/blob/main/CONTRIBUTING.md

check_broken_urls

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

Example:

markdown-checker -d . -f check_broken_urls -gu https://github.com/john0isaac/markdown-checker/blob/main/CONTRIBUTING.md

check_urls_locale

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

Example:

markdown-checker -d . -f check_urls_locale -gu https://github.com/john0isaac/markdown-checker/blob/main/CONTRIBUTING.md

check_paths_tracking

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

Example:

markdown-checker -d . -f check_paths_tracking -gu https://github.com/john0isaac/markdown-checker/blob/main/CONTRIBUTING.md

check_urls_tracking

This function ensures that any URL has tracking in it.

Example:

markdown-checker -d . -f check_urls_tracking -gu https://github.com/john0isaac/markdown-checker/blob/main/CONTRIBUTING.md