Lint and auto-format Markdown documentation before agents ship content with rumdl
Run rumdl as a fast Markdown lint-and-format gate so agents can catch style, flavor, link-adjacent, and consistency issues before docs or generated content are committed.
Prerequisites
rumdl CLI
Installation
Use the upstream install or setup path that matches your environment:
- cargo install rumdl
- brew install rumdl
- npm install -g rumdl
- npm install --save-dev rumdl
Requirements and caveats from upstream:
- Python linting, rumdl brings similar speed and developer experience improvements to the Markdown ecosystem.
- 🌐 Multiple installation options - Rust, Python, standalone binaries
- 🐍 Installable via pip for Python users
Basic usage or getting-started notes:
bash
Lint Markdown files in the current directory
rumdl check .
Source: https://github.com/rvben/rumdl
Extracted from upstream docs: https://raw.githubusercontent.com/rvben/rumdl/HEAD/README.md