markdown-formatting
强制Markdown行换行与结构规则,保持Git差异清晰
安装使用
复制下面这段提示词发给你的 AI(Claude / Cursor / TRAE / Codex / WorkBuddy 等),它会自动帮你完成安装:
帮我安装这个 AI Skill:markdown-formatting。 它的用途是:强制Markdown行换行与结构规则,保持Git差异清晰 完整的 Skill 内容见:https://321skill.com/skills/markdown-formatting-x-8/raw/index.md 请读取该页面内容,如果是 SKILL.md 格式直接安装,如果是 README 提炼核心 prompt 后安装。
提示词包含完整的 Skill 内容链接,AI 读取后即可完成安装。你也可以 查看完整内容 确认无误。
使用示例
“请使用markdown-formatting规则格式化当前文档,设置行长度为80字符。” AI将自动调整文档的换行,确保每行不超过80字符,并统一列表、标题、代码块等结构,生成整洁的Git差异。
介绍
当多人协作编辑Markdown文档时,不规范的换行和结构会导致Git差异混乱,难以审查代码变更。此Skill强制统一行长度、标题层级、列表缩进等规则,确保每次提交只显示实际改动,大幅提升代码审查效率。
安装后,在编辑器中直接调用命令或配置保存时自动格式化。支持自定义行长度、是否启用部分规则等,可集成到CI/CD流程中,在提交前自动检查并修正格式。无需额外学习成本,即装即用。
适合所有使用Markdown编写文档、博客、README、Wiki的开发者、文档工程师、技术写作者,以及需要维护干净Git历史的技术团队。尤其适合对代码审查要求严格的项目,或多人频繁协作编辑同一文档的场景。
建议在项目根目录创建配置文件统一团队规范,避免个人偏好冲突。注意,此工具会强制修改换行,对于需要保留特定手动换行格式的文档(如表格、诗歌)可能不适用,可在相应区域使用注释禁用。
核心特点
与Prettier等通用格式化工具不同,它专注于Markdown的行换行和结构规则,不处理其他代码语言,且专门优化了Git diff的整洁性,能精确控制每行字符数,避免大段重排。
注意事项
不适合需要保留手动换行格式的文档,如诗歌、表格或特定排版需求。
常见问题
如何安装?
通过npm全局安装:npm install -g markdown-formatting,或使用npx运行。
能自定义行长度吗?
可以,通过配置文件设置max_line_length参数,默认80字符。
给 AI 助手的安装指引
如果你的 AI 编程助手(Claude Code、Cursor、TRAE 等)能看到这个页面,把下面这段发给它即可自动完成安装:
请访问 https://321skill.com/skills/markdown-formatting-x-8/raw/index.md 读取 markdown-formatting 的原始 Skill 定义(Markdown 格式),按其中说明在我的环境里完成安装和配置。
AI 可直接读取的原始 Markdown 地址:/skills/markdown-formatting-x-8/raw/index.md(查看排版版本)