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 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.
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
mdXXXto 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
24 Jan 2, 2023
15.5k Jan 1, 2023
65 Nov 9, 2022
3.8k Dec 20, 2022
34 Dec 29, 2022
2k Dec 30, 2022
3 Oct 24, 2022
2 Oct 18, 2022
0 Jan 11, 2022
4 Nov 19, 2022
3 Mar 4, 2022
28 Dec 17, 2022
193 Dec 12, 2022
24 Dec 27, 2022
293 Jan 2, 2023
133 Jan 1, 2023
221 Dec 1, 2022
3 Jun 24, 2022
53 Jan 3, 2023
81 Dec 18, 2022