MD046/code-block-style:代码块样式[预期:缩进;实际:围栏]

MD046/code-block-style: Code block style [Expected: indented; Actual: fenced]

我正在为我的工作区尝试一些文档,但这个错误比预期更让我烦恼。

简单的解决方案是保留默认设置并编辑您的 Markdown,始终始终使用相同样式的代码块。毕竟,这就是 linter 的意义所在。鼓励一致、格式良好的 Markdown。

但是,当然,您可能想要更改默认值。我假设您正在使用 markdownlint plugin for VSCode。如文档中所述:

Rules can be enabled, disabled, and customized by creating a JSON file named .markdownlint.jsonc/.markdownlint.json or a YAML file named .markdownlint.yaml/.markdownlint.yml or a JavaScript file named .markdownlint.js in any directory of a project.

您可以在项目的根目录下创建上述文件之一,并根据需要自定义行为。由于您没有说明您想要什么行为,我会注意到 Rule MD046.

有多个选项
  1. consistent(默认):对每个代码块强制执行首先找到的样式。换句话说,所有代码块都必须缩进或围栏。你不能混用。
  2. fenced:所有代码块必须被隔离。任何缩进的代码块都会引发错误。
  3. indented:所有代码块必须缩进。任何受保护的代码块都会引发错误。
  4. false:禁用规则并允许一种或两种样式的代码块。随意混搭。

如果您使用的是 YAML 文件,它可能如下所示:

MD046: fenced

只需将 fenced 换成您喜欢的选项即可。