VS Code编写Markdown触发MD046代码块风格告警的配置咨询

规则配置位置 #

• markdownlint全量规则（含MD046）支持两级配置入口，优先级从高到低为：
  • 项目工作区级配置：放置在当前项目根目录下的.markdownlint.json、.markdownlint.yaml或.markdownlintrc文件，仅对当前工作区内的Markdown文档生效
  • 全局用户级配置：对所有项目的Markdown文档生效
• MD046的核心配置参数为style，支持三个可选枚举值：
  • indented：要求所有代码块必须采用4空格缩进的缩进式写法
  • fenced：要求所有代码块必须采用三反引号/三波浪线包裹的围栏式写法
  • consistent：自动匹配当前文档内第一个代码块的写法风格，不做强制统一要求
• 调整规则风格要求的配置示例，若需将规则调整为认可围栏式代码块，在对应配置文件中加入以下内容即可：

  {
    "MD046": {
      "style": "fenced"
    }
  }
  

VS Code端相关设置说明 #

• 界面上展示的MD046告警为VS Code安装的markdownlint扩展的校验结果，不属于VS Code原生功能，无需额外开启新的功能开关
• 无需手动在项目内创建配置文件时，可直接调整VS Code全局设置完成规则修改：
  • 打开VS Code设置面板，搜索markdownlint.config选项
  • 在选项输入框中填入上述MD046配置内容，保存后即可全局覆盖默认规则要求
• 配置优先级注意事项：若工作区路径下存在项目级.markdownlint.json配置文件，该文件内的规则会覆盖VS Code用户级的配置内容，若修改VS Code设置后告警未消失，优先检查工作区根目录下是否存在该配置文件，调整文件内的MD046参数即可
• 临时绕过校验的方式：如果不需要对特定文件执行MD046校验，可在VS Code设置的markdownlint.ignore选项中添加对应文件路径或通配符，跳过指定文件的规则校验，该方式属于临时规避，不推荐作为长期解决方案

内容的提问来源于stack exchange，提问作者aatif shaikh