VSCode markdownlint插件自定义生效规则


VSCode markdownlint插件自定义生效规则

markdownlint是一款VSCode下的markdown文件lint插件。可以格式化markdown文件。但是markdown默认的规则较多,查看markdownlint的商店介绍页面,有MD001-MD048共48条规则。其中有些规则可能是对个人不必要的,可以自定义启用的规则。

自定义规则的两种方式

markdownlint支持两种自定义启用规则的方式,分别是使用.markdownlint.json和使用VSCode的setting.json文件。

1.使用.markdownlint.json配置

Rules can be enabled, disabled, and customized by creating a JSON file named .markdownlint.json (or .markdownlintrc) or a YAML file named .markdownlint.yaml (or .markdownlint.yml) in any directory of a project. The rules defined by .markdownlint{.json,.yaml,.yml,rc} apply to Markdown files in the same directory and any sub-directories without their own .markdownlint{.json,.yaml,.yml,rc}.

markdownlint的规则可以被使用,被警用或者自定义。只需要在项目的任意目录下新建一个名为.markdownlint.json的文件。.markdownlint.json中的配置被应用到同级和子目录下(如果子目录下不包含.markdownlint.json文件)的md文件。该配置文件支持.json,.yaml,.yml,rc等格式,作用是相同的。

.markdownlint.json中可以定义如下配置:

{
    "default": true,
    "MD003": { "style": "atx_closed" },
    "MD007": { "indent": 4 },
    "no-hard-tabs": false
}

第一行是使用默认规则
第二行第三行是修改MD003的默认条件
第四行是修改markdownlint的设置
如果要忽略某个规则,例如忽略MD025,可以加上一条"MD025: false",就可以禁用MD025这条规则了

2.使用VSCode的setting.json文件

markdownlint同时也支持在VSCode的user或workspace下的settings.json中添加markdownlint自定义配置
例如在user的setting.json下添加如下配置:

"markdownlint.config": {
    "default": true,
    "MD025": false,
    "MD045": false,
    "no-hard-tabs": false
}

该配置就会全局生效
如果配置在workspace下的setting.json中,就对当前项目生效。
通过user和workspace下的setting.json配合可以实现一套通用的规则组合和某个项目下适用的特殊规则组合


文章作者: suifeng
版权声明: 本博客所有文章除特別声明外,均采用 CC BY 4.0 许可协议。转载请注明来源 suifeng !
  目录