Atom Markdown 警告

Question

使用 Atom 1.17.0 x64，在 Markdown 中编辑

给定:

# Header

- list item

# Header 2

  - list item 2

---

"remark-lint"在Atom中给我提供了冲突的警告。

Incorrect list-item indent: add 2 spaces (remark-lint:list-item-indent)

Incorrect indentation Before bullet: remove 2 spaces (remark-lint:lint-item-bullet-indent)

我做错了什么？

- Mark Weber

Answer 1

您正在将列表项缩进两个空格而不是四个或零。虽然大多数Markdown解析器对于嵌套列表少于四个空格的缩进都会按照您的期望处理，但如果每个级别的空格数量不一致，则可能变得模糊不清。

您的“列表项2”是否打算作为根级别的列表项？如果是，则不应缩进。或者它是作为代码块的一部分（也许演示列表项的Markdown语法）？那么它应该缩进四个空格。您的意图不明确，因此linter会给出错误，并允许您选择基于您的意图解决哪些错误。

例如，虽然缩进的列表项显然没有父列表项（标题不是列表项），但我在第一眼看到时错过了它，并假设它打算嵌套在上一个项目下面。换句话说，您的两个空格缩进引入了歧义。

Linter鼓励“最佳实践”，而不仅仅是“足够好”。由于规则没有明确说明少于四个空格是允许的，因此即使解析器没有强制执行，linter也会严格执行四个空格的规则。因此，“最佳实践”是只使用四个空格增量进行缩进。这就是linter的期望。

参考文献，这里是规则的相关部分：

列表项可以包含多个段落。每个列表项中的后续段落都必须缩进4个空格或一个制表符...

如果要在列表项中放置代码块，则代码块需要缩进两次 — 8个空格或两个制表符...

- Waylan

---

使用四个空格缩进会让我变成注释 :( - PaulProgrammerNoob