A markdown link validation reporting tool.
Project description
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
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 the available functions likecheck_broken_paths
,{gu}
with your contribution guidance full URL. - The output will be displayed in the terminal and in a
comment.md
file.
For more customizations read the docs.
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:
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
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for markdown_checker-0.2.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 47dcc3a911ba44ec4e267550a6bb932e20f5d8d855b663e64c20b7aceac5eb3d |
|
MD5 | a91580abe29a8f0147e4a36e9e78e6c6 |
|
BLAKE2b-256 | a1553cb57bc66fa7784beaa5c80ea2afc5e71b4c43aca3ed646f06a3b9350de9 |