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}
. Replace{src}
with the directory you want to analyse and {func} with the available functions like check_broken_paths. - The output will be displayed in the terminal.
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.7.tar.gz
(6.2 kB
view hashes)
Built Distribution
Close
Hashes for markdown_checker-0.0.7-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 9e26d00025d8601fc9844589dd997d0e854b210bba1b1710ca570be093da74cf |
|
MD5 | 1732dfb22093e89c6a3e3958dc745ff5 |
|
BLAKE2b-256 | e666d35daaed2db0f871b8dfcf47265847ca12eb9bdf1227c414da9d3a22533d |