Markdown Linter
即时检查 Markdown 的格式与风格错误。实时显示规则 ID、行号和可点击导航的检查结果。在浏览器中运行,Markdown 内容不会发送到服务器。
- 在浏览器中处理
- 工具不会把输入上传到 ZeroTool 服务器
- 免费 · 无需注册
用微信扫描以下二维码即可分享
示例、说明与常见问题 带实际输出的示例、与同类工具的差别,以及常见问题。
检测内容
检查器应用完整的 markdownlint 规则,包括:
- MD001 — 标题层级每次只能增加一级
- MD009 — 行尾不应有空格
- MD010 — 不使用制表符(应使用空格)
- MD012 — 不连续出现多个空行
- MD018 — ATX 标题的 # 后要有空格
- MD022 — 标题前后应有空行
- MD025 — 文档中只能有一个顶级标题
- MD026 — 标题末尾不加标点
- MD031 — 代码围栏前后应有空行
- MD034 — 不使用裸 URL,应使用链接语法
- MD041 — 第一行应为顶级标题
中文文档里常见的报错
用中文输入法写 Markdown,常见的两种情况是 # 后面忘了空格,以及标题末尾带了全角冒号。下面这份安装说明粘贴进工具后,「复制结果」得到三行:
#安装说明
## 注意事项:
运行 `npm install` 之前先确认 Node.js 版本。
行 1 [MD018] No space after hash on atx style heading [#安装说明]
行 3 [MD026] Trailing punctuation in heading — Punctuation: ':'
行 1 [MD041] First line in a file should be a top-level heading [#安装说明]
#安装说明少了空格,不是标题,而是一行普通文字,所以同一行还报了 MD041(第一行不是一级标题)。- MD026 默认检查的标点是
.,;:!。,;:!,包含全角的句号、逗号、分号、冒号和感叹号;问号不在其中,## 常见问题?不会被报(见 MD026 文档)。 - 结果按规则编号排序,同一规则内再按行号排序,所以行 1 的 MD041 排在行 3 的 MD026 后面。
检查器看不出的问题
markdownlint 检查的是写法,不渲染文档。下面这段内容在页面上有两处显示不对,检查结果却是空的:
# 填写说明
**注意:**这里必须填写手机号。
- 基本信息
- 姓名
未发现问题
- 第 3 行的加粗不会生效。结束的
**前面是全角冒号、后面紧跟汉字,按 CommonMark 0.31.2 第 6.2 节的规则它不能结束强调,两组**会原样显示。 - 第 6 行开头是全角空格(U+3000),不是缩进,所以「- 姓名」不会成为子列表,而是接在「基本信息」后面的文字。
这类问题要在 Markdown 预览里看渲染结果才能发现。
示例:一份更新日志
按 Keep a Changelog 的结构写的中文更新日志,每个版本下面都有「新增」:
# 更新日志
## 1.2.0
### 新增
- 导出按钮
## 1.1.0
### 新增
* 深色模式
详见 https://example.com/releases
「复制结果」得到(markdownlint 0.40,默认规则,输入以换行结尾;没有末尾换行时还会多报一条 MD047):
行 13 [MD004] Unordered list style — Expected: dash; Actual: asterisk
行 11 [MD024] Multiple headings with the same content [新增]
行 15 [MD034] Bare URL used [https://example.com/releases]
- 两个版本下都有「新增」标题,所以触发 MD024。这正是 Keep a Changelog 的标准写法;在你自己的配置里写
"MD024": { "siblings_only": true },就允许不同父标题下出现同名标题。 - MD004 要求整篇文档用同一种列表符号;第一个列表用了
-,所以*被标出。 - MD034 要求把裸 URL 写成
<https://example.com/releases>或 Markdown 链接。
这里改不了的默认设置
工具按默认设置运行 markdownlint 默认启用的全部规则(见 markdownlint rules)。页面没有配置项,有两条默认规则经常带来噪音:
- MD013 行长度上限 80 个字符。一行 104 个字符的英文段落会报
Expected: 80; Actual: 104。第 80 列之后没有空格的长行不报,所以不含空格的长中文行通常能通过;但中英文之间加了空格(如「运行 npm install 之前」)或用了全角空格,只要第 80 列之后出现空格,这一行仍会被报。 - MD024 会标出文档里任何重复的标题文字,比如上面的更新日志。
想按自己的规则检查,把配置写进 .markdownlint.json,在本地或 CI 里运行 markdownlint-cli2:
{
"MD013": { "line_length": 120 },
"MD024": { "siblings_only": true }
}
markdownlint 会跳过文件开头的 YAML front matter,其中的 title 在 MD041 里算作一级标题。
限制
- 规则描述和详情来自 markdownlint,在所有语言版本中都是英文。
- 工具只报告问题,不自动修复;markdownlint-cli2 的
--fix可以修复其中一部分。 - 一次检查一份文档,使用默认设置,不能上传
.markdownlint.json。文内的<!-- markdownlint-disable MD013 -->、<!-- markdownlint-enable MD013 -->和<!-- markdownlint-disable-next-line MD034 -->注释可以对局部停用规则。 - 不检查拼写、文档外链接是否有效,也不判断 GitHub 等渲染器的实际显示效果。
隐私
markdownlint 在本页中运行。Markdown 内容不会上传,工具也不把它保存到浏览器存储;刷新页面后编辑框恢复为示例文档。统计只记录「复制结果」复制成功,复制失败时不记录。
相关工具
- Markdown 预览 — 实时将 Markdown 渲染为 HTML
- Markdown 表格生成器 — 可视化构建格式化表格
FAQ
我的内容会上传到服务器吗?
不会。markdownlint 打包在本页中,在浏览器里检查 Markdown,内容不发往服务器,工具也不写入浏览器存储。页面加载 Google Analytics,「复制结果」复制成功时记录工具名和「copy_results」动作,不包含 Markdown 和检查结果;复制失败或没有问题可复制时不记录。
检查器会检测哪些规则?
按默认设置运行 markdownlint 0.40 的全部 53 条规则,涵盖标题层级、行尾空格、空行数量、裸 URL、列表格式、代码围栏等。MD043(必需的标题结构)、MD044(专有名词大小写)这类规则要先配置才会报告,本页没有配置项,所以它们不会出现。
MD001 这样的规则 ID 是什么意思?
规则 ID 遵循 markdownlint 约定:MD001 的别名是 heading-increment(标题层级一次只升一级),MD009 是 no-trailing-spaces(行尾空格),MD041 是 first-line-heading(第一行应为一级标题)。每条规则的说明在 markdownlint 仓库的规则文档里。
点击结果可以跳转到对应行吗?
可以。点击任意检查结果,编辑器会滚动到对应行并选中该行,方便立即修改。
这与命令行 markdownlint 工具有何区别?
命令行工具可集成到构建流程并检查磁盘上的文件,还能读取配置文件。本工具适合在编写或审阅 Markdown 时快速检查,无需安装任何软件。
加粗在页面上没生效,为什么检查器不报错?
markdownlint 只检查写法风格,不判断渲染结果。像 **注意:**这里 这样,结束的 ** 前面是全角标点、后面紧跟汉字时,按 CommonMark 规则它不能结束加粗,页面上会原样显示星号,但检查结果是「未发现问题」。可以在 ** 后加空格,或在 Markdown 预览里确认显示效果。