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.
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
markdown-checker-0.0.8.tar.gz
(8.1 kB
view hashes)
Built Distribution
Close
Hashes for markdown_checker-0.0.8-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 8f601f9494c3c1d6689b40f3093f7364b894f5e2dc7e80c5646a4f3c05711318 |
|
MD5 | 6eac0234fa9cfcc7dd65dc146f20ed94 |
|
BLAKE2b-256 | e8d825f907e97e944c62cac84adfd6fcb06cecfb30c7e12e39f664e5527310a7 |