The rumdl is a fast Markdown linter and formatter written in Rust. It checks Markdown files for common style and formatting problems, reports violations with detailed diagnostics, and can automatically fix many issues. This tutorial demonstrates how to install rumdl on Ubuntu 26.04.
Install rumdl
Get the most recent release version of rumdl from its GitHub repository:
RUMDL_VERSION=$(curl -s "https://api.github.com/repos/rvben/rumdl/releases/latest" | grep -Po '"tag_name": "v\K[0-9.]+')
Download the corresponding archive and extract executable into /usr/local/bin:
curl -sSL https://github.com/rvben/rumdl/releases/latest/download/rumdl-v$RUMDL_VERSION-x86_64-unknown-linux-gnu.tar.gz \
| sudo tar xz -C /usr/local/bin rumdl
Once the rumdl executable has been placed in the system path, check its version to verify the installation:
rumdl --version
Testing rumdl
A small Markdown document can be used to confirm that rumdl is working as expected. Create a test file with:
nano test.md
Insert the following content:
# Project Title
#### Installation
Run the rumdl checker against the file:
rumdl check test.md
A result similar to the following will be provided:
test.md:3:1: [MD001] Expected heading level 2, but found heading level 4 [*]
Issues: Found 1 issue in 1 file (8ms)
The error message reports that the heading hierarchy is inconsistent. After a level 1 heading, checker expects the next heading to use level 2 rather than jumping directly to level 4.
Uninstall rumdl
When rumdl is no longer needed, the installed executable can be deleted with:
sudo rm -rf /usr/local/bin/rumdl
Leave a Comment
Cancel reply