# Markdown 规范

Markdown 规范的目的在于使其语法尽可能保持一致，同时确保文档的可读性和兼容性。

# 快速使用

npm i markdownlint-cli @startdt/markdownlint-config --save-dev

使用 .markdownlintrc 配置文件：

// .markdownlintrc
{
    "extends": "@startdt/markdownlint-config",
    // 自定义规则
}

或者 .markdownlint.js 配置文件：

// .markdownlint.js
module.exports = {
    extends: '@startdt/markdownlint-config',
    // 自定义规则
};

JS 配置文件必须通过 ——config 参数提供，它们不会自动加载，因为运行不受信任的代码会存在安全问题。

首先，你需要安装 MarkdownLint 扩展：DavidAnson.vscode-markdownlint

安装之后，在 .vscode/settings.json 中配置自动修复：

{
    "markdownlint.run": "onSave",
    "editor.codeActionsOnSave": {
        "source.fixAll.markdownlint": true
    }
}

完成后，在 Visual Studio Code 中使用 command + s 保存文件时，将自动进行语法检查。

如果要在 VS Code 中实时检测 Markdown 语法，必须使用 .markdownlint{.jsonc,.json,.yaml,.yml,rc} 格式的配置文件，否则将运行 markdownlint 的默认配置。