Mado

A fast Markdown linter written in Rust. Compatible with CommonMark and GitHub Flavored Markdown (GFM).

Usage

bash mado check . mado check path/to/*.md

Performance

Approx. 49-60x faster than existing linters (e.g. markdownlint).

```mermaid

config: xyChart: height: 200 titleFontSize: 14 chartOrientation: horizontal xAxis: labelFontSize: 12 titleFontSize: 14 yAxis: labelFontSize: 12

titleFontSize: 14

xychart-beta title "Linting ~1,500 Markdown files (Lower is faster)" x-axis ["mado (rust)", "markdownlint-cli (node.js)", "markdownlint (ruby)", "markdownlint-cli2 (node.js)"] y-axis "Time (seconds)" 0 --> 10 bar [0.129, 6.381, 6.609, 7.817] ```

This benchmark was conducted on a MacBook Pro (2021, M1 Max) using hyperfine with GitLab documentation as the dataset.

Installation

Homebrew (macOS and Linux)

bash brew tap akiomik/mado https://github.com/akiomik/mado.git brew install mado

Nix (macOS and Linux)

bash nix profile install github:akiomik/mado

Arch Linux (Linux)

bash pacman -S mado

Scoop (Windows)

bash scoop install https://raw.githubusercontent.com/akiomik/mado/refs/heads/main/pkg/scoop/mado.json

WinGet (Windows)

```bash

For security reasons, installing from local manifest files requires that this feature be enabled by an administrator.

For more details, see https://learn.microsoft.com/en-us/windows/package-manager/winget/install#local-install

winget settings --enable LocalManifestFiles

curl.exe -o mado.yml https://raw.githubusercontent.com/akiomik/mado/refs/heads/main/pkg/winget/mado.yml winget install -m mado.yml ```

Manually

Pre-built binaries are available for download from the release page.

Supported Rules

Mado supports most markdownlint rules.

• :whitecheckmark: Stable support
• :hammer: Unstable support
• :warning: Unsupported option(s)
• :x: Not supported

| Rule | Support | Note | |-------|--------------------|------------------------------------------------| | MD001 | :whitecheckmark: | | | MD002 | :whitecheckmark: | | | MD003 | :hammer: | | | MD004 | :whitecheckmark: | | | MD005 | :whitecheckmark: | | | MD006 | :whitecheckmark: | | | MD007 | :hammer: | | | MD009 | :whitecheckmark: | | | MD010 | :whitecheckmark: | | | MD012 | :whitecheckmark: | | | MD013 | :whitecheckmark: | | | MD014 | :whitecheckmark: | | | MD018 | :whitecheckmark: | | | MD019 | :whitecheckmark: | | | MD020 | :hammer: | | | MD021 | :whitecheckmark: | | | MD022 | :whitecheckmark: | | | MD023 | :whitecheckmark: | | | MD024 | :whitecheckmark: | | | MD025 | :whitecheckmark: | | | MD026 | :whitecheckmark: | | | MD027 | :hammer: | | | MD028 | :whitecheckmark: | | | MD029 | :whitecheckmark: | | | MD030 | :whitecheckmark: | | | MD031 | :whitecheckmark: | | | MD032 | :hammer: | | | MD033 | :whitecheckmark: | | | MD034 | :whitecheckmark: | | | MD035 | :whitecheckmark: | | | MD036 | :whitecheckmark: | | | MD037 | :whitecheckmark: | | | MD038 | :whitecheckmark: | | | MD039 | :whitecheckmark: | | | MD040 | :whitecheckmark: | | | MD041 | :whitecheckmark: | | | MD046 | :whitecheckmark: | | | MD047 | :whitecheckmark: | |

Configuration

Mado can be configured via mado.toml or .mado.toml file in the current directory. You can also use global configuration files located in:

• Linux: ~/.config/mado/mado.toml
• macOS: ~/.config/mado/mado.toml
• Windows: ~\AppData\Roaming\mado\mado.toml

For more details, see the example mado.toml and the JSON Schema for mado.toml.

GitHub Actions

Mado is compatible with GitHub Actions.

```yaml

Basic usage (runs mado check .)

• uses: akiomik/mado@v0.3.0

Custom usage (runs mado with specified arguments)

• uses: akiomik/mado@v0.3.0 with: args: '--config path/to/mado.toml check path/to/*.md' ```

Development

just is required.

Running Tests

bash just test

Linting Code

bash just lint

Benchmarking

```bash

Download Markdown dataset

./scripts/benchmarks/setup.sh

Benchmark mado, mdl and markdownlint-cli using hyperfine

./scripts/benchmarks/comparison.sh ```

Profiling

First, install flamegraph:

bash cargo install flamegraph

Then run:

bash just flamegraph

Fuzz Testing

First, install cargo-fuzz:

bash cargo install cargo-fuzz

Then run:

bash just fuzz