check-all-markdown

Checks all markdown files using markdownlint, and checks for broken links

Installation

npm install --save-dev check-all-markdown [-g]

Usage

You can either use the script in your npm scripts, or you can use it as a regular package with the api

Script Usage

check-all-markdown [dir] [--no-check-links]

Will check all markdown files (**/*.md) in the dir (default is current directory) for markdown problems using markdownlint. Additionally, it will go over all the http and path links in the markdown files and verify that they are not broken.

The script will ignore any markdown file that is in a node_modules somewhere.

If --no-check-links is present (or --check-links false) then links will not be checked.

API Usage

Sorry, didn't document it. Feel free to browse index.js to figure it out. It is just that is used to implement the script.