rumdl Markdown 文档 Lint 与格式化
将以下提示词粘贴到你的 AI 对话框中:
请根据 https://skillhub.cn/install/skillhub.md 安装 @user_3c6cb52e/lint-and-auto-format-markdown-documentation-before-agents-ship-content-with-rumdl
技能介绍
它解决什么问题
Agent 批量生成或修改的 Markdown 文档,最常见的失败不是内容错误,而是风格漂移:列表缩进不统一、标题层级混乱、链接附近缺少空格、行尾残留空白。这类问题在 review 阶段才被发现时,往往已经混进大量文件,手工修复成本高且容易遗漏。rumdl 要解决的,就是让这些机械但关键的检查在提交前被自动拦截。
技能如何工作
核心思路是把 rumdl check 变成代理发送内容之前的一道 lint-and-format 闸门:
- 对目标目录执行
rumdl check .,一次性扫描整个目录而非逐个文件处理 - 覆盖范围包括 style、flavor(方言差异)、link-adjacent(链接写法相关的连带问题)以及整体一致性四类
- 设计目标是速度:为 Markdown 生态带来接近 Python lint 工具的开发体验,让检查可以放进每次提交或代理输出前的流水线,而不是偶发性的人工抽查
适用边界
- rumdl 只做 Markdown 文本层面的静态检查,不验证链接指向的页面是否真实存在,也不审查内容的语义正确性
- 运行前提是环境里已经安装了 rumdl CLI,技能本身不负责环境初始化
- 格式化和检查规则以 rumdl 上游默认配置为准;如果项目有自定义风格约定,需要自行提供配置,否则默认规则可能与既有代码库习惯冲突
换句话说,这是一个轻量、快速的格式守门员,适合放在代理输出内容之前的最后一步,但它不能替代链接有效性测试和内容 review。
使用场景
- Agent 批量生成文档后,在提交前跑 rumdl 检查链接写法和列表缩进,防止风格漂移进入主分支。
- 合并多人提交的文档改动时,在 CI 里跑 rumdl,统一标题层级和列表缩进风格。
- 发布技术博客或 README 前,用 rumdl 清理行尾空白、规范标题层级与链接前后空格。
- 批量迁移或改写 Markdown 文档后,执行 rumdl check 验证整体风格一致性再入库。
适合人员
- 维护文档仓库的开发者:PR 里的 Markdown 改动常带缩进不一致,需要在提交前被自动拦截。
- 用 Agent 批量生成文档的工程师:希望代理输出的内容在入库前经过统一的风格检查。
- 负责文档合流的仓库管理员:多个贡献者风格各异,需要在合并阶段统一格式。
- 撰写技术博客和教程的作者:希望发布前自动检查标题层级和行尾空白,保持风格统一。