markdownlint
markdownlint 是用于 markdown 文件 的代码检查工具。
安装
首先你需要安装 markdownlint-cli。目前支持 markdownlint-cli v0.39。
shell
npm install markdownlint-cli -D
shell
yarn add markdownlint-cli -D
shell
pnpm install markdownlint-cli -D
shell
bun install markdownlint-cli -d
配置
JSON
更新你的 .markdownlint.json
。
json
{
"$schema": "https://raw.githubusercontent.com/DavidAnson/markdownlint/main/schema/markdownlint-config-schema.json",
"extends": "@modyqyw/fabric/markdownlint.json"
}
CLI
更新你的 package.json
,增加 lint:markdownlint
命令。
json
{
"scripts": {
"lint:markdownlint": "markdownlint . --fix --ignore-path=.gitignore"
}
}
整合
VSC
先安装 对应的 markdownlint 插件。
json
{
// markdown 手动保存后 markdownlint 自动修复
"[markdown]": {
"editor.codeActionsOnSave": {
"source.fixAll.markdownlint": "explicit"
}
}
}
WebStorm
WebStorm 可以使用 插件 以获取 markdownlint 支持。
lint-staged
如果你使用该库提供的 lint-staged 配置,请查看 lint-staged 章节。
如果你没有使用该库提供的 lint-staged 配置,可以参考以下配置。
javascript
// lint-staged.config.mjs
// or lint-staged.config.js with "type": "module" in package.json
export default {
'*.md': 'markdownlint --fix --ignore-path=.gitignore',
};