Mado: Fast Markdown linter written in Rust

A new markdown linter named Mado, developed in Rust, has been released, claiming to be up to 60 times faster than existing solutions such as markdownlint, and supporting CommonMark and GitHub Flavored Markdown (GFM).

Mado is a markdown linter compatible with CommonMark and GFM, designed to improve performance significantly. Benchmark tests conducted on a MacBook Pro (2021, M1 Max) indicate that Mado processes approximately 49-60 times faster than markdownlint-cli and other similar tools, depending on the dataset. It can be installed via multiple package managers, including Homebrew, Nix, and Scoop, with pre-built binaries available for download. Mado supports most markdownlint rules, with some marked as unstable or unsupported, and can be configured through local or global configuration files. It is also compatible with GitHub Actions for integration into automated workflows.

Why It Matters

This development matters because faster markdown linting can significantly improve developer productivity, especially in large documentation projects or continuous integration pipelines. By leveraging Rust’s performance capabilities, Mado could reduce linting times from minutes to seconds, enabling more efficient code reviews and documentation updates. Its compatibility with existing markdown rules and integration options makes it a relevant tool for developers seeking performance improvements.

Background

Existing markdown linters like markdownlint and markdownlint-cli are widely used but have performance limitations, especially with large datasets. The recent benchmarking, conducted on a MacBook Pro with an M1 Max chip, shows that Mado outperforms these tools considerably. The release follows ongoing efforts within the developer community to optimize tooling for markdown processing, driven by the increasing size of documentation repositories and the demand for faster CI/CD pipelines.

“Mado leverages Rust’s speed to provide a markdown linting experience that is up to 60 times faster than existing tools.”

— Aki Omik, developer of Mado

“On a MacBook Pro (2021, M1 Max), Mado processes approximately 49-60 times faster than markdownlint-cli, depending on the dataset.”

— Benchmarking report

What Remains Unclear

It is not yet clear how Mado performs across all markdown rules, especially those marked as unstable or unsupported. The long-term stability and adoption rate among the developer community remain to be seen, as well as its performance on different operating systems beyond the initial benchmarks.

What’s Next

Next steps include wider adoption within the developer community, further benchmarking across diverse datasets, and potential integration into popular CI/CD pipelines. Developers and teams will likely monitor updates to Mado for stability improvements and new features.

Key Questions

How does Mado compare to other markdown linters in performance?

Benchmark tests indicate Mado is approximately 49-60 times faster than markdownlint-cli on tested datasets, primarily due to its implementation in Rust.

What platforms does Mado support?

Mado can be installed on macOS, Linux, and Windows via package managers like Homebrew, Nix, Scoop, and Winget, with pre-built binaries available for download.

Does Mado support all markdownlint rules?

Most rules are supported, with some marked as unstable or unsupported. Support for specific rules can be checked in the documentation.

Can Mado be integrated into automated workflows?

Yes, Mado is compatible with GitHub Actions, allowing integration into CI/CD pipelines for automated markdown linting.