markdown-formatting

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

文档写作 文档工程师内容创作者全栈开发 格式化技术文档 通用 ★ 1.1k 更新于 2026-08-01

安装使用

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

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

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

使用示例

'请使用 markdown-formatting 格式化当前项目下的所有 .md 文件,确保每行不超过80字符,并统一标题层级缩进。',它会自动扫描目录,调用格式化规则,输出修改后的文件列表,并生成 git diff 预览,方便你确认变更。

介绍

在多人协作编写 Markdown 文档时,由于换行位置、段落结构不一致,导致 git diff 混乱,难以审查代码变更。本 Skill 强制统一每行长度和结构规则,使每次提交的差异清晰可读。 安装后,运行命令即可对 Markdown 文件进行格式化,自动调整行宽、标题层级、列表缩进等。可集成到 Git 钩子或 CI/CD 流程中,确保提交前自动检查并修复格式。 适合文档工程师、技术写作者、开源项目维护者、需要频繁提交 Markdown 内容的开发者。尤其适合团队协作场景,减少因格式问题引发的无效讨论。 建议配合编辑器实时格式化插件使用,提升体验。注意:本 Skill 仅处理格式,不涉及内容语义,不会改变文字含义。对于包含特殊内嵌代码块或数学公式的文档,可能需要额外配置忽略规则。

核心特点

与一般的 Markdown 格式化工具(如 Prettier)不同,本 Skill 专门面向 Git 差异优化,严格限定每行长度,避免因自动换行导致的 diff 行数膨胀,同时保留段落结构语义。

注意事项

不适用于需要保留原始行宽(如诗歌、表格)或包含复杂内联 HTML 的 Markdown 文档。

常见问题

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

Prettier 主要关注代码风格,而本 Skill 专注于 Git 差异可读性,强制行宽和结构规则,更适合团队协作场景。

如何忽略特定文件或段落?

可以通过在文档开头添加注释 `<!-- markdown-formatting:ignore -->` 来跳过格式化,或使用配置文件排除路径。

给 AI 助手的安装指引

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

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