Skip to main content

A markdown validation reporting tool

Project description

PyPi Downloads

GitHub issues Contributing

markdown-checker is a markdown validation reporting tool.

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 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

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.9.tar.gz (8.1 kB view hashes)

Uploaded Source

Built Distribution

markdown_checker-0.0.9-py3-none-any.whl (9.3 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page