本文目录
什么是 Markdown 校验？
Markdown 校验用于检查文档是否遵循正确的语法，以及能否在不同平台上正确渲染。虽然 Markdown 的设计初衷是简洁易用，但各解析器之间的差异意味着，细微的格式错误在 GitHub、GitLab 及其他工具上可能产生不同的显示结果。
如今，文档、README 文件和技术指南越来越多地采用 Markdown 编写。校验能够确保无论在何处显示，都能保持一致的渲染效果、正确的标题层级和整洁的格式。
Markdown 校验器的工作原理
CheckTown 的 Markdown 校验器会解析你的内容，检查其中的格式错误和结构问题。
- 语法校验——检查标题层级、列表格式、代码块定界符以及链接语法
- 结构分析——检测标题层级问题，例如跳级使用标题
- 链接检查——校验内联链接和引用式链接的语法，确认方括号与圆括号成对匹配
免费试用 —— 无需注册
校验你的 Markdown →常见的 Markdown 错误
Markdown 错误往往不易察觉，因为它们不会产生任何报错信息——只会导致渲染结果不正确。
- 缺少空行——Markdown 要求在标题、列表和代码块之前留出空行，才能被正确解析
- 列表标记不一致——在同一个列表中混用星号、短横线和加号，可能会让解析器产生混淆
- 链接语法错误——缺少一个方括号或圆括号，就会让链接退化为纯文本
何时使用 Markdown 校验
当文档需要在多个平台上都能正确渲染时，Markdown 校验的价值最为突出。
- 文档——在推送 README 文件之前先校验，确保在 GitHub 上正确显示
- 博客内容——在发布前检查 Markdown 文章，及时发现格式问题
- 团队规范——通过 CI 流水线在各贡献者之间统一 Markdown 风格
常见问题
该校验器使用哪种 Markdown 规范？
该校验器遵循 CommonMark 规范，GitHub、GitLab 及大多数现代解析器均支持该规范。
校验器是否支持 GitHub 风格的 Markdown？
支持。该校验器可识别 GFM 扩展语法，包括表格、任务列表、删除线和围栏式代码块。
Markdown 校验能否检出失效的链接？
该校验器会检查链接语法，但不会验证 URL 是否真正可访问。若要检测这一点，则需要使用专门的链接检查工具。