mdlint¶
mdlint is a Python Markdown linter that checks files for style and formatting violations. It helps maintain consistent Markdown in your code base or documentation project.
Features¶
- 50+ built-in rules covering headings, lists, whitespace, links, code blocks, etc.
- Configurable via
.mdlint.tomlorpyproject.tomlwith per-rule customization - Multiple output formats including human-readable terminal output and JSON
- Gitignore-aware file discovery that respects
.gitignore/.ignorepatterns - stdin support for integration with editors and or use in CI pipelines
- Built-in rule documentation accessible from the CLI, with valid/invalid examples
- Compatible (mostly) with existing
markdownlintrule sets (Ruby and JavaScript implementations)
Quick start¶
Install mdlint:
uv tool install --from git+https://github.com/mprpic/mdlint mdlint
Lint a file:
mdlint check README.md
Lint all Markdown files in a directory:
mdlint check docs/
View available rules:
mdlint rule