Markdown 检查
使用 markdownlint 检查 Markdown 的样式和语法问题。许多编辑器和 CI 流水线都使用这个检查工具。粘贴文档后,即可查看每项问题的行号、规则(例如 MD001)和说明。你还可以选择获取修正版本,由 markdownlint 自动更正能够处理的问题,例如空行、列表标记和间距。
常见问题
会检查哪些规则?
检查 markdownlint 默认启用的所有规则,从 MD001(标题级别每次递增一级)到列表、空行、代码块、链接和强调相关规则。除非设置最大行长度,否则行长度规则 MD013 默认关闭。
如何关闭规则?
在“要禁用的规则”字段中列出规则,以逗号或空格分隔,可使用 MD033 这样的编号或 no-inline-html 这样的名称。文档中的行内注释(例如 <!-- markdownlint-disable MD033 -->)也有效。
修正选项有什么作用?
它会应用 markdownlint 提供的自动修正,例如在标题和列表周围添加空行、统一列表标记或移除行尾空格,然后显示修正后的文档。没有自动修正的问题仍需你手动处理。
使用哪个版本的 markdownlint?
使用 markdownlint 0.42.0,Visual Studio Code 的 markdownlint 扩展和 markdownlint-cli2 都基于这个库构建。使用相同版本和默认配置时,它们报告的问题也相同。
为什么它会指出我的第一个标题有问题?
规则 MD041 要求文档以顶级标题开头,MD025 则只允许有一个顶级标题。如果你的平台会自行添加标题,请对文档禁用这些规则。
会显示多少项问题?
始终会报告问题总数,并在表格中列出前 500 项。修复前面的几项后重新运行检查,即可查看其余问题。