markdownlint

markdownlint is the linter for markdown file.

安装

You have to install markdownlint-cli first. Currently markdownlint-cli v0.42 is supported.

npm

npm install markdownlint-cli -D

yarn

yarn add markdownlint-cli -D

pnpm

pnpm install markdownlint-cli -D

Configuration

Create .markdownlint.json in your project root:

{
  "$schema": "https://raw.githubusercontent.com/DavidAnson/markdownlint/main/schema/markdownlint-config-schema.json",
  "extends": "@modyqyw/fabric/markdownlint.json"
}

Update package.json and add lint:markdownlint script.

{
  "scripts": {
    "lint:markdownlint": "markdownlint . --fix --ignore-path=.gitignore"
  }
}

FAQ

Integration of VSC?

Install the corresponding markdownlint plugin first.

Update user settings or workspace settings as appropriate.

{
  // markdownlint auto-fix after markdown manual save.
  "[markdown]": {
    "editor.codeActionsOnSave": {
      "source.fixAll.markdownlint": "explicit"
    }
  }
}

Integration of WebStorm?

WebStorm can use plugin to get markdownlint support.

Integration of lint-staged?

If you are using the lint-staged configuration provided by the package, see the lint-staged chapter.

If you are not, you can refer to the following configuration.

// lint-staged.config.mjs
export default {
  "*.md": "markdownlint --fix --ignore-path=.gitignore",
};