SuperAPI AI 工具集

markdown-fixer

写作与研究

查看项目

更新于 10-16 05:27

技能介绍

用途

Markdown Fixer 是一个内部辅助工具,定位为 Markdown 无障碍修复器。它接收来自 markdown-scanner 的结构化问题列表,对 Markdown 文件应用修复。它本身不扫描文件,只处理已预先分类的问题。

主要能力

可自动修复的类别

  • 描述性链接:当模糊文本有周围上下文时,依据句子上下文改写;当正文中出现裸 URL 时,用 URL 路径中的描述性文字包裹。
  • 标题层级:多个 H1 时,除第一个外全部降级为 H2;跳过标题层级时,插值补上缺失层级;粗体文本被用作视觉标题时,转换为合适的标题元素。
  • 表格:缺少前置描述时,根据列标题前置一句摘要;首个表头单元格为空时,添加“Item”或根据上下文推断。
  • Emoji:在 remove-all 模式下移除任意位置的 emoji,并在相邻文本中保留含义;在 remove-decorative 模式下移除标题中的 emoji、作为项目符号首字符的 emoji、连续两个及以上的 emoji 序列;在 translate 模式下将已知 emoji 替换为(翻译)。
  • Mermaid:在 replace-with-text 模式下,将简单图表替换为自动生成的描述,并用 details 包裹原始内容。
  • ASCII:在 replace-with-text 模式下,将 ASCII 图替换为自动生成的描述,并用 details 包裹原始内容。
  • 破折号:在 normalize 模式下,将正文中的 em-dash、en-dash、--、--- 按破折号偏好替换。

需人工判断的类别

以下问题会呈现给用户确认,不会自动应用:

  • 图片的替代文本内容:只有作者知道图片的用途。
  • 复杂 Mermaid 图:描述草稿需要作者验证。
  • ASCII 艺术图:描述必须由作者提供或批准。
  • 平实语言改写:需要理解受众、语气和意图。
  • 上下文不足的链接改写:无法确定正确的目标文本。
  • 影响文档结构的标题降级:可能需要更大范围的重构。
  • 翻译模式下的未知 emoji:无法推断翻译。

使用方式

该工具接收以下输入:来自 markdown-scanner 的结构化扫描报告、已批准的问题清单(区分自动修复与需呈现审核)、Phase 0 偏好设置(emoji 模式、破折号模式、Mermaid 模式、ASCII 模式)以及完整文件路径。

输出格式为每个文件返回一份修复报告,包含:已应用修复的表格(序号、领域、行号、变更、修改前、修改后)、呈现给人工审核的项目(问题类型、行号、当前内容、问题说明、建议修复、重要性说明、是否应用),以及文件状态(修复前问题数与评分、修复后剩余问题数与评分、已修复数量)。

每个修复应用后返回 action(变更内容)、target(文件路径与行号)、result(success | skipped | needs-review)、reason(结果非 success 时必填)。文件摘要必须包含修复前后的问题数与评分。

当由 markdown-a11y-assistant 调用时,会播报开始、逐项显示修改前后及无障碍影响说明、播报完成,失败时说明原因并保持文件不变。结果返回给 markdown-a11y-assistant,用户在应用每个修复前会看到批准提示。

适用场景

适用于对 Markdown 文档进行无障碍修复的流程,作为多智能体协作中的状态变更环节,在扫描与审核之后执行已批准的修复。

限制

  • 不得在 Phase 3 审核门完成前应用任何修复。
  • 不得自动修复替代文本内容(需要视觉判断)。
  • 不得自动修复平实语言改写(需要作者意图)。
  • 不得修改代码块、行内代码或 YAML front matter。
  • 不得修改 markdown-a11y-assistant 提供范围之外的文件。
  • 参考文件(references/fix-rules.md)仅在任务需要时读取,不要预先全部读取。
  • 共享规则、调度契约与模式见 skills/a11y-core/SKILL.md;权威规范见 skills/a11y-core/references/sources.md。