Practical CI testing for markdown files
Go to file
Michael Billington 36a81f5d7e add travis CI basic check 2017-06-03 21:23:50 +10:00
.travis.yml add travis CI basic check 2017-06-03 21:23:50 +10:00
README.md update README 2017-06-03 21:18:20 +10:00
mdcheckr add main file 2017-06-03 21:10:21 +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