关键信息
- 分类
- 开发与 Web
- 输入类型
- textarea, select
- 输出类型
- text
- 样本覆盖
- 4
- 支持 API
- Yes
概览
Markdown 规范检查器是一款在线工具,旨在帮助开发者和创作者快速检测 Markdown 文档中的风格与格式问题。它支持检查标题层级、代码围栏、列表一致性等常见规范,并提供标准、宽松和严格三种规则集,帮助您一键生成清晰的文本或 JSON 格式的诊断报告。
适用场景
- •在将 Markdown 文档提交到 Git 仓库或发布到技术博客前,需要确保排版格式统一。
- •团队协作编写技术文档时,用于统一不同成员的 Markdown 编写风格。
- •检查长篇 Markdown 文件中是否存在标题层级跳跃、代码块未闭合或列表符号混用等排版错误。
工作原理
- •将需要检查的 Markdown 文本粘贴到输入框中。
- •根据排版要求选择合适的规则集(标准、宽松或严格),并选择报告输出格式(文本或 JSON)。
- •规则引擎自动解析文档结构,实时输出包含错误行号、规则名称及修改建议的诊断报告。
使用场景
技术文档预审:在发布 API 文档或开源项目 README 之前,快速定位排版缺陷。
博客文章排版校对:检查自媒体或个人博客的 Markdown 稿件,确保标题和列表格式美观一致。
自动化 CI 脚本集成测试:通过生成 JSON 格式的报告,配合脚本在本地或 CI 流程中验证文档规范性。
用户案例
1. 修复技术文档中的标题层级混乱
技术作家- 背景原因
- 编写了一篇长达数万字的产品使用手册,由于多次修改,导致部分章节的标题层级出现了跳跃(例如直接从一级标题跳到了三级标题)。
- 解决问题
- 手动逐行检查大纲结构非常低效,容易遗漏。
- 如何使用
- 将手册的 Markdown 文本粘贴至输入框,选择“标准”规则集和“文本报告”格式,点击运行。
- 示例配置
-
规则集: standard, 报告格式: text - 效果
- 检查器迅速指出第 142 行存在“标题层级跳跃(H1 直接到 H3)”的错误,帮助作者快速定位并修复了文档大纲结构。
2. 严格模式下的代码块与列表规范检查
开源项目维护者- 背景原因
- 维护一个高质量的开源项目,要求所有贡献者提交的 Markdown 文档必须严格符合代码围栏指定语言和列表符号一致性的规范。
- 解决问题
- 贡献者提交的 PR 中经常包含未指定语言的代码块和混用的无序列表符号。
- 如何使用
- 复制 PR 中的 Markdown 内容,选择“严格”规则集和“JSON”报告格式进行校验。
- 示例配置
-
规则集: strict, 报告格式: json - 效果
- 检查器输出 JSON 格式的详细错误列表,精准指出未指定语言的代码块所在行号,便于维护者直接反馈给贡献者修改。
用 Samples 测试
markdownMarkdown 幻灯片示例
用于测试 PDF 导出的 Remark/Marp 风格 Markdown 幻灯片
title token markdown
Markdown 示例
Markdown 格式示例,从简单到复杂的文档结构
title token markdown
Markdown 链接提取示例
包含各种链接类型的 Markdown 示例文档,用于测试 Markdown 链接提取工具
title token markdown
PDF示例
2026-02-01 到 2026-02-10 工具生成的PDF示例
preferred input family markdown
相关专题
Markdown 导出、OCR 与文档转换工具
在一个专题中比较 Markdown 转 PDF、PDF 转 Markdown、OCR、幻灯片导出和结构化 Markdown 转换工具,适合文档发布流程。
Markdown 写作、整理与发布工具
把 Markdown 格式整理、链接检查、合并、预览、翻译和导出工具集中到一个专题中,适合文档、笔记和发布流程。
文档编写、提取与发布工具
在一个文档工作流专题中完成文档编写、从代码或 PDF 提取内容、检查 Markdown,并导出更正式的文档结果。
标识符、配置与输入校验工具
在一个专题里比较邮箱、手机号、IP、日期、Cron、条码、支付信息、env 文件等真实输入的校验工具。
常见问题
这个检查器会修改我的 Markdown 文件吗?
不会。它仅对输入的文本进行静态分析并输出诊断报告,不会自动修改或覆盖您的原始文本。
标准、宽松和严格规则集有什么区别?
标准规则集适用于大多数通用场景;宽松规则集忽略一些非关键的空格或换行限制;严格规则集则对标题层级顺序、列表缩进和代码块格式有极高要求。
什么是标题层级跳跃?
标题层级跳跃是指在没有二级标题(H2)的情况下直接使用三级标题(H3),这会破坏文档的逻辑大纲结构。
为什么我的代码块被标记为警告?
通常是因为代码围栏(如 ```)没有指定具体的编程语言标识符,或者未正确闭合。
诊断报告支持哪些格式输出?
支持直观易读的文本报告格式,以及便于程序解析和集成到自动化工作流中的 JSON 格式。