eslint-plugin-markdownlint

eslint-plugin-markdownlint

Eslint plugin which runs markdownlint.

Install

npm install eslint-plugin-markdownlint --save-dev

Usage

In order to use this plugin there is required to put it into override section of .eslintrc file with defined files array (select markdown files), parser and rules.

Recommended config enable all options except deprecated, all with default values and reported as error.

{
  "overrides": [{
    "files": ["*.md"],
    "parser": "eslint-plugin-markdownlint/parser",
    "extends": ["plugin:markdownlint/recommended"]
  }]
}

If you want to modify recommended rules simply add related rule to the rules section.

{
  "overrides": [{
    "files": ["*.md"],
    "parser": "eslint-plugin-markdownlint/parser",
    "extends": ["plugin:markdownlint/recommended"],
    "rules": {
      "markdownlint/md001": "off",
      "markdownlint/md003": "warn",
      "markdownlint/md025": ["error", {
        "level": 2
      }]
    }
  }]
}

If you want to configure all settings manually, ommit "extends": ["plugin:markdownlint/recommended"] (all rules will be set to 'off'), then enable/configure requested rules in "rules" section.

It's worth to define separate entry in .editorconfig if you're using it. Following example uses default settings.

[*.md]
max_line_length = 80
indent_style = space
insert_final_newline = true
trim_trailing_whitespace = true

Limitations

This plugin is in early stage of development, so:

• there isn't supported any config file like .mdlrc
• aliases for rules are not supported, you need to use codes like mdXXX to select rule, but should be available in future
• tags are not supported and there is no plans to support it

Markdownlint

For full documentation about markdownlint refer DavidAnson/markdownlint