[x-cmd] 不会写 Markdown，你就少了一半 AI 战斗力！Markdown 规范检查工具 rumdl

不会写 Markdown你就少了一半 AI 战斗力Markdown 规范检查工具 rumdl如果你想持续获取更多相关资讯欢迎关注x-cmd 博客。如果你维护过大型文档项目一定遇到过这些问题链接失效找不到、图片路径错误、行太长影响阅读、标题层级混乱、代码块缺少语言标签。这些看似小问题在文档规模变大后会严重拖累维护效率。传统的 Markdown linter 如markdownlint速度慢、规则少、配置繁琐。rumdl正是为解决这些痛点而生的——它把 Rust 生态中备受好评的ruff理念引入 Markdown 世界用极速性能和57 条规则重新定义 Markdown 代码质量检查。核心定位Markdown 世界的 ruffrumdl把自己定位为 Markdown 领域的ruff——这不是比喻而是从设计理念到实现细节的全面借鉴极速性能Rust 原生实现检查速度比markdownlint快 10-100 倍57 条规则覆盖标题、列表、空白、代码块、链接、图片、样式等各个方面自动修复--fix参数自动修复大部分问题支持 stdin/stdout 管道零依赖单个二进制文件无需运行时多方言支持自动识别 GFM、MkDocs、MDX、Quarto安装方式rumdl支持多种安装途径X-CMD 用户可一键安装# X-CMD 安装xinstallrumdl# 直接下载二进制# 访问 https://github.com/rvben/rumdl/releases基础使用rumdl提供三个核心命令check、fmt、init。check - 代码检查# 检查当前目录rumdl check.# 检查指定文件rumdl check README.md# 检查并自动修复rumdl check--fix.# 监听模式文件变化时自动检查rumdl check--watchdocs/fmt - 格式化# 格式化当前目录rumdlfmt.# 格式化单个文件rumdlfmtREADME.md格式化命令不会报告无法修复的违规——即使存在无法自动修复的问题也会返回成功适合 CI 环境。init - 生成配置# 生成默认配置文件rumdl init这会在当前目录创建.rumdl.toml配置文件。常用命令行选项选项说明--config指定配置文件路径--disable禁用指定规则如--disable MD013,MD033--enable启用指定规则--exclude排除文件/目录逗号分隔--include只检查匹配的文件--watch监听模式持续检查--respect-gitignore是否遵守 .gitignore默认 true--no-exclude禁用所有排除模式--stdin-filename指定 stdin 的文件名用于规则检测stdin/stdout 管道用法# 格式化 stdin 输入echo# Title |rumdlfmt-catREADME.md|rumdlfmt-README_formatted.md# 检查 stdin 内容catREADME.md|rumdl check - --stdin-filename README.md配置说明rumdl 使用 TOML 格式配置文件默认按以下顺序查找.rumdl.tomlrumdl.toml.config/rumdl.toml也可以在pyproject.toml中配置[tool.rumdl] # 启用/禁用规则 enable [MD001, MD003] disable [MD013, MD033] # 文件过滤 include [docs/*.md, README.md] exclude [node_modules, dist, CHANGELOG.md] # Markdown 方言 markdown gfm # gfm, mdx, mkdocs, quarto # 规则特定配置 [tool.rumdl.rules] MD013 { line_length 100 } MD009 { br_spaces 2 }查看配置rumdl config# 查看有效配置rumdl config--defaults# 只显示默认值rumdl config --no-defaults# 只显示非默认值规则集一览rumdl 实现了54 条规则官方文档有时显示 57 条按类别分组类别规则数示例Headings标题MD001-MD003标题层级、符号一致性Lists列表MD004-MD007列表标记样式、缩进Whitespace空白MD009-MD012行尾空格、硬标签Code代码MD040, MD046-MD048代码块语言标签Links链接MD034, MD039-MD042链接格式、引用Images图片MD045, MD052-MD053alt 文本、图片引用Style样式MD031-MD036块引号、水平线查看完整规则列表rumdl rule或访问在线文档https://rumdl.dev/RULES常用规则场景# 禁用表格列宽限制MD.table_columnsrumdl check--disableMD.table_columns docs/# 禁用代码块语言要求MD040rumdl check--disableMD040.# 禁用行长度检查MD013rumdl check--disableMD013 README.mdGitHub Actions 集成-name:Lint Markdownuses:rvben/rumdlv1with:args:check .或手动安装后使用-name:Install rumdlrun:cargo install rumdl-name:Lint Markdownrun:rumdl check .编辑器集成VS Code安装 VS Code 扩展搜索 “rumdl”。Vim/Neovim 格式化当前文件 :,!rumdl fmt - --quiet 格式化整个文件 :%!rumdl fmt - --quiet与同类工具对比特性rumdlmarkdownlintmdl性能极速Rust慢Ruby慢Ruby规则数546040自动修复✅❌❌依赖零RubyRuby配置格式TOMLYAML/JSONRuby多方言✅ GFM/MkDocs/MDX/Quarto有限有限rumdl 的核心优势在于速度和自动修复能力——这让它在大型项目和 CI/CD 环境中特别有价值。学习建议rumdl 的使用非常简单建议按以下路径快速上手先运行一次rumdl check .看看项目有哪些问题使用--fix自动修复大部分问题创建配置rumdl init根据项目需求调整规则加入 CI每次 PR 自动检查保持代码库整洁对于 Markdown 风格要求严格的项目如开源框架文档建议启用所有规则然后根据实际情况选择性禁用。