markdown-formatting

强制 Markdown 换行与结构规则,保持 Git 差异干净

安装使用

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

帮我安装这个 AI Skill:markdown-formatting。
它的用途是:强制 Markdown 换行与结构规则,保持 Git 差异干净
完整的 Skill 内容见:https://321skill.com/skills/markdown-formatting-x-3/raw/index.md
请读取该页面内容,如果是 SKILL.md 格式直接安装,如果是 README 提炼核心 prompt 后安装。

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

使用示例

'帮我格式化这个Markdown文件,按照每行80字符换行,并修复标题层级缩进。' 它会自动读取文件内容,应用规则,输出整洁的Markdown,确保Git diff只显示真正的改动。例如,在提交前运行 `npx markdown-formatting --fix` 即可一键修复所有文件。

介绍

在团队协作中,Markdown 文档的格式混乱常常导致 Git 差异难以阅读,大量无意义的换行和空格变化会淹没真正的代码变更,增加代码审查成本。本 Skill 通过自动检测并修复 Markdown 文件中的换行和结构违规,确保每次提交只包含有意义的改动,让 diff 变得清晰、可追溯。

使用方式极为简单:安装后,可以将其集成到 Git 的 pre-commit 钩子或 CI 流程中,在提交前自动格式化 Markdown 文件。支持自定义行宽、标题层级间距、列表缩进等规则,适配团队已有的编码规范。只需一条命令即可扫描当前仓库中的所有 Markdown 文件,并输出修复建议或自动更正。

适合需要频繁撰写技术文档、会议纪要、API 文档的团队,尤其是前端开发、后端开发和文档工程师。对于使用 Git 进行版本控制的项目,无论项目规模大小,都能显著提升代码审查体验。也适用于个人博客、开源项目维护者,帮助保持文档风格一致。

建议在首次使用时先运行一次全量格式化,然后通过 .markdown-formatting.json 配置文件锁定规则,避免后续反复争论格式。注意该 Skill 只处理 Markdown 文件,不涉及其他格式如 HTML 或 LaTeX;对于包含大量数学公式或自定义语法的 Markdown,请先测试规则是否兼容。

核心特点

区别于 Prettier 等通用格式化工具,本 Skill 聚焦于 Markdown 的换行和结构规则,专门优化 Git 差异的可读性,而非单纯美化排版;并提供可配置的行宽和段落分隔规则,深度适配团队协作场景。

注意事项

不适合处理包含复杂内联 HTML、JSX 或自定义语法的 Markdown 文件,可能破坏原有结构。

常见问题

这个 Skill 和 Prettier 有什么区别?

Prettier 是通用格式化工具,本 Skill 专注于 Markdown 的换行和结构规则,专门为 Git 差异洁净设计,配置更精细化。

如何集成到 Git 提交前钩子?

安装后,在项目根目录添加 pre-commit 钩子,执行 `npx markdown-formatting --check` 即可。也可在 CI 中运行 `npx markdown-formatting --fix` 自动修复。

给 AI 助手的安装指引

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

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