Markdown文档格式化

技能简介

Markdown-Formatter是一款用于格式化、清理和美化Markdown文档的工具。支持多种样式规范（CommonMark、GitHub Flavored Markdown及自定义规则），可处理从简单清理到复杂重排版的各类需求。

业务背景

规范企业知识库文档质量。各部门撰写的Markdown文档风格不一，标题层级混乱、列表格式混杂，影响协作阅读与后续自动化处理。本工具按CommonMark或GitHub等标准统一格式化，确保文档结构清晰、机器可读，降低维护成本。

落地案例：技术团队维护200篇API文档，因多人协作导致格式参差不齐，部分标题层级错误影响自动生成目录。使用Markdown格式化技能，选定GitHub规范批量处理全部文件，自动修复缩进、统一代码块样式、优化标题结构。处理后文档可直接对接静态站点生成器，发布效率提升显著。

能做什么

• 按指定样式规范格式化Markdown内容
• 批量处理多个Markdown文件
• 检查并修复文档格式问题
• 优化标题层级结构
• 规范化列表标记与缩进
• 调整代码块间距与换行宽度

使用说明

安装指令：

clawhub install markdown-formatter

单文档格式化：

const result = await formatMarkdown({
  markdown: '# My Document\n\n\n## Section 1\nContent here...',
  style: 'github',
  options: { maxWidth: 80, headingStyle: 'atx' }
});
console.log(result.formattedMarkdown);

批量格式化：

const results = await formatBatch({
  markdownFiles: ['./doc1.md', './doc2.md'],
  style: 'github',
  options: { wrapWidth: 80 }
});

仅检查不修改：

const result = await lintMarkdown({
  markdown: '# My Document',
  style: 'github'
});
console.log(`Errors found: ${result.errors}`);

输入与输出

见下方输入与输出表格。

风险提示

• 格式化操作会修改原始内容，建议先备份重要文档
• 自定义HTML内容可能被转换或移除（取决于preserveHtml设置）
• 批量处理时部分文件失败不会中断整体流程，需检查结果确认
• 链接验证功能依赖网络请求，可能因超时导致检查不完整

来源信息

原始链接：https://github.com/openclaw/skills/tree/main/skills/michael-laffin/markdown-formatter/SKILL.md
来源类型：开源社区技能