markdown-formatting

自动格式化 Markdown 文档,生成干净的 Git 差异对比。

安装使用

复制下面这段提示词发给你的 AI(Claude / Cursor / TRAE / Codex / WorkBuddy 等),它会自动帮你完成安装:

帮我安装这个 AI Skill:markdown-formatting。
它的用途是:自动格式化 Markdown 文档,生成干净的 Git 差异对比。
完整的 Skill 内容见:https://321skill.com/skills/markdown-formatting-x-7/raw/index.md
请读取该页面内容,如果是 SKILL.md 格式直接安装,如果是 README 提炼核心 prompt 后安装。

提示词包含完整的 Skill 内容链接,AI 读取后即可完成安装。你也可以 查看完整内容 确认无误。

使用示例

‘请使用 markdown-formatting 工具格式化当前目录下的所有 .md 文件,设置最大行宽为 80 字符。’,它会扫描并应用格式化规则,调整换行和结构,输出格式化后的文件列表和变更摘要。或者,在提交代码前

对AI说:‘将 markdown-formatting 加入项目的 pre-commit 钩子。’,它会指导你如何安装和配置,确保每次提交的 Markdown 文档都保持格式统一。

介绍

这个 Skill 主要解决 Markdown 文档在版本控制中因格式不一致(如换行、空格、列表缩进)导致的 Git 差异(diff)混乱问题。它通过自动执行预设的格式化规则,确保文档结构清晰、行宽统一,使代码审查和版本历史追踪更加高效。

使用时,你只需在需要格式化的 Markdown 文件或目录上运行该工具。它会根据配置的规则(如最大行宽、列表项处理方式)自动调整文档格式,无需手动逐行调整。通常可以集成到 Git 提交钩子(pre-commit hook)或 CI/CD 流程中,实现自动化格式化。

它非常适合需要频繁协作编写和维护技术文档、项目 README、API 文档或任何 Markdown 格式文件的开发团队。对于追求代码仓库整洁、希望提升代码审查效率的工程师和文档维护者来说尤其有用。

建议在项目初期就引入此工具,并统一团队成员的格式化配置。注意,它主要关注于 Git diff 的清晰度,而非 Markdown 的语法校验或渲染效果。对于已存在大量格式不一致的旧文档,建议先在小范围文件上测试,确认格式化效果符合预期后再批量应用。

核心特点

与通用的 Markdown 美化工具(如 Prettier)不同,此 Skill 的核心设计目标明确指向“生成干净的 Git 差异”,其规则(如严格的单行换行策略)专门为优化版本控制中的行级对比而定制,而非仅仅追求视觉美观或符合某种风格指南。

注意事项

不适合用于格式化对行内样式、复杂表格或特定渲染效果有严格要求的 Markdown 文档,可能会改变原始布局意图。

常见问题

这个工具和 Prettier 的 Markdown 格式化有什么区别?

它更专注于通过强制换行等规则来优化 Git 的行级差异对比,而 Prettier 等工具更侧重于代码风格统一和可读性,目标不同。

能集成到 Git 提交前自动运行吗?

可以,通常通过配置 pre-commit hook(例如使用 husky)来在提交前自动格式化 Markdown 文件。

给 AI 助手的安装指引

如果你的 AI 编程助手(Claude Code、Cursor、TRAE 等)能看到这个页面,把下面这段发给它即可自动完成安装:

请访问 https://321skill.com/skills/markdown-formatting-x-7/raw/index.md 读取 markdown-formatting 的原始 Skill 定义(Markdown 格式),按其中说明在我的环境里完成安装和配置。