Markdown 语法检查

按 markdownlint 的常用规则检查 Markdown 文档:标题层级、重复标题、代码块语言、裸链接、图片替代文字、空行和行尾空格等;再加上中文排版检查,例如中英文之间加空格、中文句子使用全角标点。问题逐行列出,大部分可以一键自动修复。

检查的规则

编号规则可自动修复
  • 规则编号与 markdownlint 保持一致(MD 开头),中文排版规则以 CN 开头,参考了《中文文案排版指北》的常见约定。项目里可以用 markdownlint-cli2 或 VS Code 的 markdownlint 扩展做同样的检查。
  • 代码不参与检查:代码块和行内代码中的内容不会做中文排版检查,也不会被自动修复改动。
  • 中英文空格有不同主张:有的团队不加空格(依靠字体渲染的间距),这时取消“中文排版检查”即可。

把 Markdown 转成网页或公众号富文本,请用 Markdown 转 HTML。

Markdown 语法检查常见问题

Markdown 语法检查怎么使用?

把 Markdown 粘贴到左侧,右侧实时列出问题的行号、规则编号和说明,点击某一行会在左侧选中对应内容;可以设置是否检查中文排版、第一行是否必须是一级标题、每行最大长度和列表符号,点“自动修复”处理可修复的问题。

markdownlint 是什么?

一套常用的 Markdown 格式规则和检查工具,规则以 MD 加数字编号,VS Code 中有同名扩展。

中文和英文之间要加空格吗?

《中文文案排版指北》等规范建议加空格,可读性更好,但也有团队不加,按项目约定即可。

为什么代码块要标明语言?

标明语言后渲染器才能正确高亮代码,读者也更容易看懂。

标题为什么不能跳级?

从二级标题直接跳到四级会破坏文档结构,目录和读屏软件都依赖正确的层级。

Markdown 语法检查的结果应怎样理解?

实现了 markdownlint 中最常用的一部分规则,不包括全部规则;中文排版检查会跳过代码块、行内代码和链接地址。

输入内容会保存或发给外部服务吗?

文档只在浏览器本地检查,不会上传。

没有结果或操作失败时先检查什么?

自动修复后格式不符合预期时,可以撤销(Ctrl+Z)后关闭相关选项再修复;不希望中英文之间加空格时取消“中文排版检查”。

相关工具

README 生成器 · JSON 格式化校验 · Base64 编码解码 · URL 编码解码 · 全部开发工具