詳解markdownlint

一、插件簡介

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、文件編碼檢測

markdownlint.config = {
    "default" : true,
    "MD001": [true, {"front_matter_title": ""}]
};

2、文本內容檢測

markdownlint.config = {
    "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-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
};

3、其他功能

// 忽略一些常見的文件擴展名
"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足以滿足大部分使用者的需求。