From a24dfaff6645e23300105fa1534860fa69c71231 Mon Sep 17 00:00:00 2001 From: Michael Billington Date: Sun, 4 Jun 2017 21:22:56 +1000 Subject: [PATCH] Update README.md --- README.md | 11 ++++++++++- 1 file changed, 10 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 539ba2d..a9768a3 100644 --- a/README.md +++ b/README.md @@ -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