vacp2p
/
mdcheckr
mirror of
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Update README.md

This commit is contained in:
Michael Billington 2017-06-04 21:22:56 +10:00 committed by GitHub
parent 37a38a0080
commit a24dfaff66
1 changed files with 10 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
README.md
View File

@ -1,6 +1,15 @@
# mdcheckr [![Build Status](https://travis-ci.org/mike42/mdcheckr.svg?branch=master)](https://travis-ci.org/mike42/mdcheckr)
Practical CI testing for markdown files.
`mdcheckr` is a testing tool to detect quality problems with your Markdown documentation. It is designed to act as a quality gate in your continuous integration pipeline.
- **Syntax errors in code blocks** - Syntax-check code blocks that identify their language. Currently works for:
- bash ([example](tests/04_codeblock_bash_bad.md))
- PHP ([example](tests/05_codeblock_php_bad.md))
- **Code blocks**- Detection of un-closed code blocks ([example](tests/06_codeblock_plain_bad.md))
- **Broken links**- Flag files that link to relative paths or URLs on the internet which can't be accessed ([example](tests/00_rel_link_bad.md), [example](tests/01_abs_link_bad.md)).
- **Broken images**- Detect broken embeds, local and remote ([example](tests/02_rel_img_bad.md), [example](tests/03_abs_image_bad.md)).
This tool is not intended to enforce a code style, and will not critique aspects of your Markdown code which do not affect the output.
## Dependencies