mdbook-lint

A fast linter for mdBook projects.

📖 Documentation | 🚀 Getting Started

Installation

From Prebuilt Binaries (Recommended)

Download the latest release for your platform from GitHub Releases:

• Linux (x86_64): mdbook-lint-linux-x86_64
• Linux (musl): mdbook-lint-linux-x86_64-musl (static binary, no dependencies)
• Windows: mdbook-lint-windows-x86_64.exe
• macOS (Intel): mdbook-lint-macos-x86_64
• macOS (Apple Silicon): mdbook-lint-macos-aarch64

Extract and add to your PATH, or use with GitHub Actions (see CI Integration).

From Cargo

cargo install mdbook-lint

Usage

CLI

# Lint files
mdbook-lint lint README.md src/*.md

# Show available rules
mdbook-lint rules

mdBook Preprocessor

Add to your book.toml:

[preprocessor.mdbook-lint]

Then run mdbook build as usual.

Configuration

Create a .mdbook-lint.toml file:

fail-on-warnings = true
disabled-rules = ["MD013"]  # Disable line length rule

Rules

• 59 standard rules (MD001-MD059) - All the usual markdown linting
• 4 mdBook rules (MDBOOK001-004) - mdBook-specific checks

Run mdbook-lint rules --detailed to see all available rules.

Contributing

Contributions are welcome! See our Contributing Guide for complete information.

License

MIT OR Apache-2.0