Practical CI testing for markdown files
Go to file
Michael Billington ade4b3429d detect missing dependencies, bump build env version 2017-06-03 22:08:06 +10:00
tests add very basic tests 2017-06-03 21:57:37 +10:00
.travis.yml detect missing dependencies, bump build env version 2017-06-03 22:08:06 +10:00
README.md update README 2017-06-03 21:18:20 +10:00
mdcheckr detect missing dependencies, bump build env version 2017-06-03 22:08:06 +10:00

README.md

mdcheckr

Practical CI testing for markdown files.

Dependencies

Requirements:

  • curl
  • xmllint
  • pandoc

Installation

curl https://raw.githubusercontent.com/mike42/mdcheckr/master/mdcheckr -o mdcheckr
chmod +x mdcheckr
sudo cp mdcheckr /usr/local/bin

Usage

Check a single markdown file:

mdcheckr README.md

Check all the markdown files in the current directory:

find . -name '*.md' -print0 | xargs -0 mdcheckr

Check all the markdown files in your Git repository:

git ls-files | grep '\.md$' | tr '\n' '\0' | xargs -0 mdcheckr