markdown-formatting

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

代码质量 文档工程师项目经理 格式化技术文档统一团队开发规范 通用 ★ 1.1k 更新于 2026-07-31

安装使用

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

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

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

使用示例

'请使用 markdown-formatting 规则格式化当前文档',它会自动调整每行字符数、标题前后空行、列表缩进,确保 Git 提交时只显示实际内容变更,干净整洁。

介绍

在团队协作中,Markdown 文档的格式混乱会导致 Git 对比时出现大量无关修改,难以审查。本 skill 通过强制统一的换行和结构规则,确保每次提交只包含实际内容变更,提升协作效率。

安装后,在编辑器中打开 Markdown 文件,自动应用规则,或通过命令行运行格式化命令。它会自动调整段落换行(每行不超过指定字符数)、标题前后空行、列表缩进、代码块标记等,并生成干净的 diff。

适合需要频繁编写和审查 Markdown 文档的团队,包括文档工程师、项目经理、后端开发等。

建议在项目中集成 pre-commit 钩子,自动格式化后再提交,避免手动遗漏。注意该工具不会修改文档内容语义,仅调整格式。

核心特点

与同类工具(如 prettier、remark-lint)相比,本 skill 专注于 Git diff 优化,通过精准的行尾换行策略,使得每次修改只影响变更行,而非整个段落重排,极大减少 diff 噪声。

注意事项

不适合需要保留原文手动换行风格(如诗歌、表格)的场景,强制换行可能破坏原有排版。

常见问题

如何忽略某些文件?

可以在项目根目录创建 .markdown-formatting-ignore 文件,列出忽略模式。

支持哪些编辑器?

支持 VS Code、JetBrains 等主流编辑器,也可通过命令行使用。

给 AI 助手的安装指引

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

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