mcpField
V
verifying-markdown-formatting

verifying-markdown-formatting

github.com/spencerpauly文档处理868410 次安装12 周前更新
代码仓库

关于 verifying-markdown-formatting

用于检查并修正 Markdown 文件格式的技能,同时保留原有结构。涵盖标题、列表、链接、代码、表格、空白和其他排版规范。

主要功能

  1. 01检查标题层级与间距
  2. 02检查列表标记和缩进一致性
  3. 03检查链接、图片和代码格式
  4. 04检查表格、空白及分隔线
  5. 05保留作者原有结构

适用场景

  1. 01发布前检查 Markdown 文档
  2. 02统一项目文档的格式

安装

复制下面的命令,在终端中运行。

$npx skills add https://github.com/spencerpauly/awesome-cursor-skills --skill verifying-markdown-formatting

安装后在 Claude Code 中输入/verifying-markdown-formatting确认已加载。

详细介绍

验证 Markdown 格式

检查 Markdown 文件是否存在格式问题,并修复这些问题。

检查内容

结构
  • 文件顶部恰好有一个 # H1 标题
  • 标题级别逐级递增(不能从 ## 跳到 ####)
  • 每个标题前后都有空行
  • 每个代码块、列表和引用块前后都有空行
  • 文件以一个换行符结尾
列表
  • 每个列表中的标记样式保持一致(不要混用 -、* 或 +)
  • 嵌套项缩进 2 或 4 个空格(全文保持一致)
  • 顶层列表的第一项前有空行
  • 紧凑列表的各项之间没有空行(或者各项之间都加空行,二选一)
链接和图片
  • 所有链接都有非空显示文本:[text](url),而不是 [](url)
  • 代码块外没有裸 URL — 用 <url> 或 [text](url) 包裹
  • 引用式链接都有对应的定义
  • 图片有替代文本:![alt](src),而不是 ![](src)
代码块
  • 围栏代码块使用三个反引号,而不是波浪号
  • 每个围栏代码块都有语言标识符(```python、```bash 等)
  • 短引用使用单个反引号标记行内代码
  • 不使用缩进式代码块(为清晰起见,改用围栏代码块)
格式
  • 粗体使用 **text**,而不是 __text__
  • 斜体使用 *text*,而不是 _text_
  • 所有行末尾都没有多余空格
  • 在可行的情况下,行长少于 120 个字符(正文,不包括表格)
  • 统一使用 ATX 风格标题(# Heading,而不是下划线风格)
表格
  • 表头行下方有分隔行,且每列都有 ---
  • 单元格内容没有多余空格
  • 如有列对齐标记(:---、:---:、---:),则使用方式保持一致
水平分隔线
  • 使用独占一行的 ---,且上下各有一个空行
  • 样式保持一致(不要混用 ---、***、___)

工作流程

  1. 阅读目标 Markdown 文件
  2. 逐项检查上述内容
  3. 使用精确的字符串替换修复发现的问题
  4. 重新阅读文件,确认所有问题均已妥善修复
  5. 报告已修复的内容以及原本正确的内容

说明

  • 此技能仅用于格式检查 — 不验证内容准确性、失效链接或拼写
  • 保留作者原本意图的结构;不要重新组织章节
  • 修复列表标记时,采用文件中使用最多的样式

评论

支持 Markdown