Markdownlint Config
My personal shareable markdownlint configuration.
Install
yarn add -D markdownlint @waldronmatt/markdownlint-configUsage
.markdownlint.json
{
"extends": "./node_modules/@waldronmatt/markdownlint-config/index.json"
}Extending
.markdownlint.json
{
"extends": "./node_modules/@waldronmatt/markdownlint-config/index.json",
"MD013": false,
}Add an NPM Script
Running this command:
npm set-script lint:md "markdownlint --fix **/*.md --ignore node_modules --ignore **/CHANGELOG.md"Will create:
package.json
"scripts": {
"lint:md": "markdownlint --fix **/*.md --ignore node_modules --ignore **/CHANGELOG.md"
},Add a Pre-commit Hook
lint-staged.config.js
module.exports = {
'*.md': ['prettier --cache --write', 'markdownlint'],
};Under The Hood
index.json
markdownlint-cli
License
MIT