Practical CI testing for markdown files
Go to file
Michael Billington 08c87d4d9d add scripts for building deb package 2017-06-04 20:53:37 +10:00
debian add debian files, fist cut 2017-06-04 18:59:14 +10:00
tests tests for non-terminated code blocks 2017-06-04 15:39:11 +10:00
.travis.yml add scripts for building deb package 2017-06-04 20:53:37 +10:00
CONTRIBUTING.md update packaging code 2017-06-04 20:44:25 +10:00
LICENSE.md add license file 2017-06-04 14:12:13 +10:00
Makefile add package creation to Travis CI script 2017-06-04 20:45:26 +10:00
README.md add build badge to README 2017-06-03 22:13:10 +10:00
mdcheckr rm TODO comment 2017-06-04 16:03:03 +10:00
mdcheckr.1 add manpage 2017-06-04 15:55:51 +10:00

README.md

mdcheckr Build Status

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