developerVilchez / mdlint

CLI tool to lint your markdown files using the markdownlint module

mdlint

CLI tool to lint your markdown files using the markdownlint module.

Installation

Globally:

npm i -g Laboratoria/mdlint

In your project:

npm i --save-dev Laboratoria/mdlint

Once you have installed it in your project you can add a task in your package.json to run the linter:

{
  "name": "your-package",
  "version": "0.0.0",
  "scripts": {
    "lint": "mdlint ."
  },
  "devDependencies": {
    "mdlint": "Laboratoria/mdlint"
  }
}

This will allow you to run the linter like this:

npm run lint

Usage

$ mdlint --help
Usage:

  mdlint [path1] [path2] ...

Options:

  -c, --config   Path to config file. Default: '.mdlintrc'
  -i, --ignore   Path to file with patterns to ignore. Default: '.mdlintignore'
  -v, --verbose  Show verbose output.
  -h, --help     Show this help.
  -V, --version  Show mdlint version.

Laboratoria 2017

Configuration

.mdlintrc

{
  "default": true,
  "ul-style": { "style": "sublist" },
  "no-duplicate-header": false
}

.mdlintignore

node_modules/
bower_components/