Markdown 规范化
符号统一、缩进对齐,代码块原样不动
如何使用本工具
- 粘整篇 Markdown,右边立刻出规范化结果,下方 chips 显示改了多少行。
- 「列表符号」统一成一种,混用 * + - 的项目读起来最乱,这里能一次抹平。
- 「嵌套缩进」按你项目的习惯选 2 或 4,缩进层级会按全文最小缩进反推再对齐。
- 代码围栏里的内容一个字符都不动,包括多余的空行和行尾空格。
- 点「看改动清单」逐行列改前改后,确认没被误改再复制。
常见问题
Q:为什么代码块里的内容没被规范化?
A:因为代码块里的空白和符号都有意义,改一个空格可能让缩进语法报错、改一个星号可能让正则失效。围栏内的每一行原样输出,只清理行尾空白。这也是所有 Markdown 格式化器的第一原则:不动代码块。
Q:列表缩进怎么算的?
A:先扫全文找出最小的非零列表缩进当基准(比如都缩 4 格就认为一层是 4),再按这个单位换算层级,最后按你选的 2 或 4 重排。硬编码 2 或 4 遇到 3 格缩进的老文档会整体错位,所以要先探测。
Q:表格对齐会不会把中文列算错?
A:会。这里按字符数算宽度,一个汉字算 1,但等宽字体里汉字占两个字符宽,所以纯中文表格看起来会偏。这是纯前端工具的固有局限——真正的对齐需要知道字体的实际度量,浏览器里拿不到可靠值。数字和英文列的对齐是准确的。
Q:Setext 标题为什么要改成 # 写法?
A:因为 `文字\n===` 这种写法有歧义:下一行的 `---` 既可能是二级标题的下划线,也可能是分隔线或 YAML 结束标记。GitHub 现在也推荐 ATX 写法,改过来以后任何解析器都不会误判。
Q:连续空行压成一个会不会破坏 Markdown 语义?
A:不会。Markdown 里两个以上空行和两个空行的渲染结果完全一样,都是段落分隔。唯一例外是代码块内部——那里不压,原样保留。
Q:有序列表的符号也被改了?
A:只把 `1)` 改成 `1.`,序号本身保留。有些解析器不认 `1)` 这种写法,统一成 `.` 最安全。如果你想重新编号(1 2 3 全打乱),那不是格式化工具该干的事。
Q:能修 Markdown lint 的全部规则吗?
A:不能,只覆盖排版层面最常见的几类:列表符号、缩进、标题空行、空行数量、表格对齐、围栏。行长度限制(MD013)、链接有效性(MD034)、标题层级跳跃(MD001)这些要么需要联网要么需要完整 AST,用 markdownlint 更合适。