A markdown validation reporting tool
Project description
markdown-checker is a markdown validation reporting tool.
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 like check_broken_paths, {gu} with your contribution guidance full URL. - The output will be displayed in the terminal and in a
comments.md
file.
Using markdown-checker in GitHub Actions
The tool has been designed to be run 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.
Supported Functions
Check broken relative paths
This function ensures that any relative path in your files is 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 country locale present in URLs
This function ensures that any relative path in your files is working.
Example:
markdown-checker -d . -f check_urls_locale -gu https://github.com/john0isaac/markdown-checker/blob/main/CONTRIBUTING.md
Check Contributor ID missing from paths
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 Contributor ID missing from URLs
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.1.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 7dc288789cc84e52148b0ab0eb091adcb79d385ee6e458e6f31522ae2a02667c |
|
MD5 | 69cf4d901a917e56c6d273092c0293d0 |
|
BLAKE2b-256 | 9a4950c1e345d4ee8152b2f65cb1cbf96a46f8f877f4b0256d82546f8662c6ac |