关键信息
- 分类
- 文本与写作
- 输入类型
- textarea, select, checkbox
- 输出类型
- html
- 样本覆盖
- 4
- 支持 API
- Yes
概览
Markdown 规范与风格检查器是一款专业的文档质量检测工具，能够依据 15 条经典的 markdownlint 规则和 2 条中文排版规范，快速扫描并定位 Markdown 文本中的格式与风格问题，同时支持一键自动修复尾随空格、空行及列表标记等安全项，帮助您轻松产出排版优雅、结构规范的文档。
适用场景
- •在发布技术文档、README 或博客文章前，需要确保 Markdown 语法正确且排版整洁时。
- •团队协作编写文档时，需要统一标题层级、列表标记和中英文混排的空格规范时。
- •需要快速批量修复 Markdown 文件中的尾随空格、多余空行或缺失的末尾换行等常见格式问题时。
工作原理
- •粘贴需要检查的 Markdown 文本，并根据需求选择“默认”、“严格”或“宽松”规则集。
- •检查器将文档切分为标题、列表、代码块等不同区块，并运行规则引擎进行逐行扫描。
- •系统输出带行号的问题清单，若开启了自动修复，将直接应用安全规则并输出修正后的 Markdown 文本。
使用场景
开源项目维护者在合并 PR 前，对 README.md 进行规范性检查与自动格式化。
技术作家在发布中文技术教程前，自动纠正中英文混排缺失空格（CN001）的问题。
团队文档库管理，通过严格模式统一所有 Markdown 文件的标题样式与列表前缀。
用户案例
1. 修复开源项目 README 格式混乱
开源项目维护者- 背景原因
- 维护者收到了一份社区贡献的 README.md，但其中存在列表标记混用、代码块未指定语言以及中英文间缺少空格等排版问题。
- 解决问题
- 需要快速统一列表标记，并在中英文间添加空格，同时找出未指定语言的代码块。
- 如何使用
- 将 README 内容粘贴至输入框，选择“默认”规则集并勾选“自动修复安全项”，点击运行。
- 示例配置
-
规则集: 默认, 自动修复: 开启 - 效果
- 列表标记统一为“-”，中英文间自动插入空格，尾随空格被清除，同时报告中指出第 8 行代码块缺少语言标识，便于手动修改。
2. 规范技术博客的标题层级与空行
技术博主- 背景原因
- 博主撰写了一篇长文，由于多次修改，导致部分标题层级跳跃（如 h1 直接到 h3），且代码块前后遗漏了空行。
- 解决问题
- 检查并修复文档中的标题递增错误，以及代码块和列表周围的空行规范。
- 如何使用
- 粘贴博客 Markdown 源码，选择“严格”规则集，开启自动修复并运行。
- 示例配置
-
规则集: 严格, 自动修复: 开启 - 效果
- 自动在代码块和列表前后插入了必要的空行，并生成报告提示第 12 行存在标题跳级（MD001）问题，提示博主手动调整标题级别。
用 Samples 测试
markdownMarkdown 示例
Markdown 格式示例，从简单到复杂的文档结构
title token markdown
Markdown 幻灯片示例
用于测试 PDF 导出的 Remark/Marp 风格 Markdown 幻灯片
title token markdown
Markdown 链接提取示例
包含各种链接类型的 Markdown 示例文档，用于测试 Markdown 链接提取工具
title token markdown
Test Pyramid Examples - 测试策略指导
全面的测试金字塔实现示例，包括单元测试、集成测试、端到端测试、测试组织和平衡软件质量保证的战略测试模式
preferred input family markdown
相关专题
Markdown 导出、OCR 与文档转换工具
在一个专题中比较 Markdown 转 PDF、PDF 转 Markdown、OCR、幻灯片导出和结构化 Markdown 转换工具，适合文档发布流程。
Markdown 写作、整理与发布工具
把 Markdown 格式整理、链接检查、合并、预览、翻译和导出工具集中到一个专题中，适合文档、笔记和发布流程。
文档编写、提取与发布工具
在一个文档工作流专题中完成文档编写、从代码或 PDF 提取内容、检查 Markdown，并导出更正式的文档结果。
音频编码与格式转换工具
在一个专题里比较音频格式转换、码率调整、采样率转换、编码切换和导出工具，适合交付与归档工作流。
常见问题
自动修复功能会修改我的文档内容吗？
不会。自动修复仅应用于去除尾随空格、折叠空行、规范列表标记等安全且确定性的格式调整，不会改动文字内容或标题层级。
什么是 CN001 中文排版规则？
该规则要求在中文与拉丁字母或数字之间添加空格（例如将“使用Python3”规范为“使用 Python 3”），以提升阅读体验。
严格、默认和宽松规则集有什么区别？
默认包含 15 条 markdownlint 和 2 条中文规则；严格版增加了行长度和有序列表前缀检查；宽松版则仅保留错误提示，忽略风格警告。
为什么有些检测到的问题没有被自动修复？
诸如标题跳级（MD001）或代码块缺少语言标注（MD040）等问题需要人工确认，因此不会进行自动修改，仅在报告中列出。
该工具支持哪些 Markdown 语法元素的检查？
支持检查标题层级、无序与有序列表、代码围栏、空链接、图片 alt 属性、尾随空格及换行等。