详解markdownlint

发布时间:2023-05-19

一、插件简介

Markdownlint是一款用来规范化Markdown文档风格的VS Code插件。通过检查文档中的语言错误、排版规范、文本格式等方面,使得Markdown文档风格更加整洁、易读。作为一款流行的MarkDown编辑器VS Code的插件,markdownlint已经成为许多人编辑和发布markdown文档时的标配。

二、插件的激活

markdownlint的插件界面比较友好,激活也非常简单,下面介绍多种激活方式:

  1. 直接在Visual Code插件商店搜索markdownlint并安装,即可使用。
  2. 在Visual Code中按下Ctrl+Shift+P或者Cmd+Shift+P,打开命令行,输入 “ext install markdownlint”,即可安装
  3. 在Visual Code左侧菜单中,找到插件Logo,在搜索框中输入”markdownlint”并安装即可。

三、markdownlint规则

在使用markdownlint插件时,它会对文本进行规则检测,以下是markdownlint解决的常见规则:

  1. 文件编码检测
{
  "default": true,
  "MD001": [true, {"front_matter_title": ""}]
}
  1. 文本内容检测
{
  "default": true,
  "no-multiple-blanks": false,
  "no-inline-html": true,
  "line-length": false,
  "no-trailing-spaces": false,
  "no-tabs": true,
  "no-emphasis-as-header": true,
  "no-missing-space-atx": true,
  "no-missing-space-closed-atx": true,
  "no-missing-space-fence": true,
  "no-space-in-emphasis": true,
  "no-space-in-code": true,
  "no-space-in-links": true,
  "no-bare-urls": true,
  "no-empty-links": true,
  "ul-indent": [true, 1],
  "no-missing-space-between-links": true,
  "blanks-around-headings": true
}
  1. 其他功能
// 忽略一些常见的文件扩展名
"markdownlint.ignore": [
  "**/*.js",
  "**/*.css",
  "**/*.html"
],
// 可自定义级别
"markdownlint.config": {
  "default": true,
  "MD041": false,
  "MD036": {
    "severity": "warning",
    "style": "consistent"
  }
},
"editor.codeActionsOnSave": {
  "source.fixAll": true
}

四、插件使用技巧

  1. 鼠标悬停提示错误。
  2. 多个错误可以一并修复。
  3. 允许自定义部分规则。
  4. 忽略文件或文件夹
  5. 标准化文本标签。

五、插件评价

markdownlint清晰明了,使用起来也很方便,建议所有使用VS Code编辑Markdown文档的人操作使用一下,可以大大提高Markdown文档的整洁度和可读性。总的来说,markdownlint足以满足大部分使用者的需求。