Markdown 检查器
Markdown 检查器是一款免费的在线IT 开发工具,Markdown 检查器是一款免费的在线IT 开发工具,输入参数即可实时得出结果;纯前端运行、数据不上…
📝 Markdown Linter
Markdown Linter - Check heading levels, list formatting, link syntax and duplicate headings, with fix suggestions. Free, browser-only.
📐 工作原理与说明
检查 Markdown 文档的规范与风格问题。
- 检查项:标题层级是否跳级、列表缩进是否一致、行尾多余空格、代码块是否标注语言。
- 常见问题:一级标题后直接跳三级、同一文档多个一级标题、链接与图片缺少说明。
- 规则集:可参考 markdownlint 的编号规则(如 MD013 行宽、MD041 首行应为标题)。
- 价值:统一文档风格,提升可读性与长期可维护性。
⚠️ 使用说明与注意事项
- 标题建议从 H1 起逐层递增,跳级会影响文档大纲与 SEO 锚点。
- 无序列表 `-`/`*` 后需一个空格;有序列表 `1. ` 后也需空格,否则不渲染为列表。
- 本检查为风格辅助,不覆盖 CommonMark 全部语法;导出前仍建议用官方解析器预览。
📋 常见规范
| 写法 | 说明 |
|---|---|
| # 标题 | H1 一个文档一个 |
| - 项 | 符号后空格 |
| [文本](url) | 链接需地址 |
📚 深度解析:Markdown Linter
💡 常见使用场景
- 检查 MD 风格与潜在问题。
- 给团队文档定规范:提交前跑一遍检查,把标题层级跳级、链接失效、行尾空格这些问题挡在评审之前。
检查
标题层级跳级、列表缺空格等给出警告。
❓ 常见问题(FAQ)
- 规则可配吗?
- 多数 linter 支持配置文件禁用规则。
- 为什么它报的问题看起来不重要?
- 因为 lint 检查的是「一致性与可维护性」而非「正确性」:行尾空格、标题前后空行、列表缩进统一,单看都不影响渲染,但混在一起会让 diff 噪音变大、多人协作难以对齐。可按团队习惯关掉部分规则,但建议至少保留结构类规则。