mdcheckr/README.md

43 lines
704 B
Markdown
Raw Normal View History

2017-06-03 12:13:10 +00:00
# mdcheckr [![Build Status](https://travis-ci.org/mike42/mdcheckr.svg?branch=master)](https://travis-ci.org/mike42/mdcheckr)
2017-06-03 11:10:21 +00:00
Practical CI testing for markdown files.
2017-06-03 11:18:20 +00:00
## Dependencies
2017-06-03 11:10:21 +00:00
Requirements:
- curl
- xmllint
- pandoc
2017-06-03 11:18:20 +00:00
## Installation
2017-06-03 11:10:21 +00:00
```bash
2017-06-03 11:18:20 +00:00
curl https://raw.githubusercontent.com/mike42/mdcheckr/master/mdcheckr -o mdcheckr
chmod +x mdcheckr
sudo cp mdcheckr /usr/local/bin
2017-06-03 11:10:21 +00:00
```
## Usage
2017-06-03 11:18:20 +00:00
Check a single markdown file:
```
mdcheckr README.md
```
2017-06-03 11:10:21 +00:00
Check all the markdown files in the current directory:
2017-06-03 11:18:20 +00:00
```
2017-06-03 11:10:21 +00:00
find . -name '*.md' -print0 | xargs -0 mdcheckr
2017-06-03 11:18:20 +00:00
```
2017-06-03 11:10:21 +00:00
Check all the markdown files in your Git repository:
```bash
git ls-files | grep '\.md$' | tr '\n' '\0' | xargs -0 mdcheckr
```