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

aat*_*ikh 4 markdown codeblocks

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

  • 如果我需要定义我的代码块样式那么在哪里?

  • 或者我需要在 VS Code 中启用或更新设置?因为我正在使用 VS Code 创建此标记文件。

在此输入图像描述

Way*_*lan 6

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

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

可以通过在项目的任何目录中创建名为.markdownlint.jsonc/的 JSON 文件或名为/.markdownlint.json的 YAML 文件或名为 / 的 JavaScript 文件来启用、禁用和自定义规则。.markdownlint.yaml.markdownlint.yml.markdownlint.js

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

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

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

MD046: fenced
Run Code Online (Sandbox Code Playgroud)

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