SuperAPI AI 工具集

markdown-lint-cleanup

写作与研究

查看项目

更新于 10-16 04:04

技能介绍

用途

Markdown Lint Cleanup 用于清理 Markdown 文件,使其通过 lint 检查并达到零警告。它聚焦于一致的标题、间距以及围栏代码块的语言标签,适合在不改动文档内容含义的前提下规范化格式。

主要能力

该技能针对常见的 Markdown lint 警告提供修复规则,包括:

  • MD036:用强调(加粗)代替标题。应将仅加粗的标题替换为 ##、### 等正式标题。
  • MD032:列表周围缺少空行。需确保列表前后各有一个空行。
  • MD022:标题周围缺少空行。需在标题前后添加空行。
  • MD040:围栏代码块缺少语言标识。需添加 bash、php、sql 或 text 等合适的语言标签。
  • MD031:围栏代码块周围缺少空行。需确保代码围栏与其他文本之间有空行。

核心规则(必需)包括:标题必须是正式标题;列表前后要有空行;围栏代码块前后要有空行;围栏代码块要带语言标签。

使用方式

推荐工作流:

  1. 识别 lint 警告及其行号。
  2. 应用针对性修复(标题、间距、代码围栏语言)。
  3. 反复检查 lint 直至干净。

技能说明中要求先阅读 SKILL.md,然后仅加载任务所需的深层参考文件,按有序指导、检查清单和决策规则执行,而不是挑选孤立片段。输出应面向执行、简洁,并与仓库基线工程标准一致;除非技能明确要求更严格的标准,否则保持与现有项目约定兼容。

适用场景

  • 出现 Markdown lint 警告(MD022、MD032、MD036、MD040、MD031)。
  • 文档更新需要一次干净的 lint 通过。
  • 大型文档需要在不改动内容的情况下进行格式规范化。

限制与注意事项

文件安全方面要求:不改变含义或内容结构;仅调整格式以满足 lint 规则;原样保留链接和引用。

不应使用的情况:任务与 markdown-lint-cleanup 无关,或更适合由更具体的配套技能处理;请求只需要简单答案,且本技能的任何约束或参考都没有实质帮助。

反模式包括:把示例当作可直接复制的真理而不检查适用性、约束或失败模式;默认加载所有参考文件而不是渐进式披露。

输出与证据

输出应为适合任务的具体结果:实现指导、审查发现、架构决策、模板或生成的产物;当任务无法仅凭现有上下文完成时,明确说明假设、权衡或未解决的缺口;在能实质改善执行时,列出使用的参考、配套技能或后续行动。

证据产物示例:正确性类别下,Markdown lint 清理记录,格式为 Markdown 文档,跟踪每轮修复的 lint 警告(标题、列表周围空行、带语言标签的围栏),示例路径 docs/lint/markdown-cleanup-2026-04-16.md。

平台说明

可选辅助插件在某些环境中可能有帮助,但不得视为本技能的必需项。

致谢

由 Peter Bamuhigire 分享,techguypeter.com,+256 784 464178。