Files
CraftKit/plugins/doc/skills/format-md/SKILL.md
T

1.9 KiB

name, description
name description
format-md 整理 Markdown 文件或指定片段的排版与语法格式,同时保持原有事实、措辞和语义不变。适用于空行、标题、列表、代码块、表格及链接格式修正;内容改写、摘要或新增图示不应触发本 Skill。

Markdown 排版

在不改变内容含义的前提下修正 Markdown 排版。优先遵循当前项目已有的 Markdown 风格;没有明确约定时采用一致、易读的常见写法。

工作范围

  • 修正标题层级、标题前后空行和正文分段。
  • 统一有序列表、无序列表及嵌套缩进。
  • 修正围栏代码块、语言标记和代码块周围空行。
  • 对齐已有表格的分隔行、列数和必要空格。
  • 修正明显损坏的 Markdown 链接、引用及强调语法。
  • 用户指定行号或章节时,只处理该范围,并保留范围外内容。

内容边界

  • 不改写句子,不替换术语,不增删事实、结论、数字或要求。
  • 不因追求美观改变章节顺序、列表顺序或信息层级。
  • 不默认把段落转换成表格,也不新增流程图、状态图或时序图。
  • 不修复链接指向的外部内容;只能修正可确定的 Markdown 语法。
  • 发现语义矛盾、信息缺失或需要结构性重写时,保留原文并单独说明,不擅自处理。
  • 格式调整会影响渲染语义时,先向用户确认。

执行方式

  1. 读取目标文件及项目内适用的协作约定。
  2. 确认处理范围;未指定时处理整个目标文件。
  3. 识别纯排版问题和可能改变语义的结构问题。
  4. 只修改能够确定不会改变内容含义的格式。
  5. 检查标题、列表、代码块、表格和链接结构是否完整。
  6. 报告处理范围、主要格式调整及保留未改的问题。

若用户只要求查看或评估排版问题,保持只读并给出建议,不写回文件。