
原站网页截图,页面可能随时间更新。
rumdl 面向需要持续维护 Markdown 文档的个人作者、开发者和团队。它把规则检查、自动格式化、缓存和编辑器集成放在同一套命令行工具中,适合在写作、提交代码或构建文档时快速发现格式问题。
用途与适用场景
rumdl 的核心用途是检查 Markdown 内容是否符合既定规范,并在可处理的情况下自动调整格式。它覆盖常见的 Markdown 问题,提供 90 条检查规则,同时兼容较广泛的 markdownlint 配置。对于需要多人协作维护的项目,统一标题、列表、空行、链接等写法,可以减少文档风格不一致。
它适用于个人 Markdown 文件、项目说明文档、技术文档和代码仓库中的文档维护,也适合放入编辑器或 CI/CD 流程,在保存、提交或自动构建时反馈问题。工具还支持 Rust 文档注释中的 Markdown,包括 /// 和 //! 注释。
准备与上手
rumdl 以命令行方式运行,提供原生二进制文件,并可通过 Homebrew、Cargo、npm、pip、uv、mise、Nix、winget 等方式安装;也可以直接运行 uvx rumdl check .,在不安装到本机的情况下检查当前目录。它是单个二进制程序,不需要运行时依赖。
安装后,使用 rumdl check . 检查目录,使用 rumdl fmt . 格式化文件。需要自动修复时,可以运行 rumdl check --fix;工具会自动修复能够处理的问题,并报告仍然无法修复的违规项。首次使用还可以运行 rumdl init 创建默认配置文件。
主要功能
rumdl 同时提供检查和格式化能力,格式化操作既可处理文件,也支持标准输入和标准输出。检查结果包含详细错误信息,并可通过非零退出码向自动化流程报告问题,因此适合接入提交检查和 CI/CD。
它内置多种 Markdown 风格支持,包括 GFM、MkDocs、MDX、Quarto 和 MyST,并能根据支持的文件名自动识别部分风格。工具支持 TOML 配置文件,能够发现常见的 markdownlint 和 markdownlint-cli2 配置,因此已有相关配置的项目可以先沿用原有设置。
缓存机制会让后续检查只重新处理发生变化的文件,适合编辑器集成和持续检查。除命令行使用方式外,项目还提供编辑器集成、LSP、GitHub Actions、pre-commit 集成和 JSON 输出等面向开发流程的能力。
使用时的限制
自动修复并不意味着所有问题都能被改正。rumdl check --fix 会处理可修复的违规项,无法修复的内容仍会被报告;格式化命令在存在无法修复的违规项时也可能以成功状态退出,因此不能只依据退出状态判断文档是否完全符合规则。
工具的行为受规则和配置影响,不同 Markdown 风格可能采用不同解析或检查方式。对于存在歧义的 Markdown 或 MDX 内容,部分规则可能只报告问题而不自动重排。它主要面向命令行和开发流程,官网资料未显示其提供独立的图形化编辑界面。
官网列出的发行版包含 Linux、macOS 和 Windows 的部分架构,也提供 Python、npm 等安装方式;实际可用方式取决于所使用的平台和安装环境。
rumdl 能否直接修改 Markdown 文件?
可以。使用 rumdl fmt 可格式化文件,使用 rumdl check --fix 可自动修复能够处理的检查问题;无法自动修复的违规项仍会被报告。
已有 markdownlint 配置时需要重新配置吗?
不一定。rumdl 会自动发现常见的 markdownlint 和 markdownlint-cli2 配置文件,可以先使用现有配置运行检查。