Scroll to navigation

ruby-mdl(1) General Commands Manual ruby-mdl(1)

NAME

ruby-mdl - Markdown lint tool

SYNOPSIS

mdl [ options ] [FILE.md|DIR ...]

DESCRIPTION

ruby-mdl checks an individual markdown file, or a directory of markdown files against a set of 47 rules for syntax consistency. In its report back to the CLI, the Ruby based implementation reports the line(s) with an issue identified and how to improve it.

OPTIONS

The configuration file to use
Only process files known to git when given a directory
Ignore YAML front matter
JSON output
Don't process any files, just list enabled rules
Only process these rules
Specify additional ruleset files to load
Show rule aliases instead of rule ID when viewing rules
Show kramdown warnings
Don't load the default markdownlint ruleset
Load the given style
Only process rules with these tags
Increase verbosity
Show this message
Show version

AUTHOR

Mark Harrison, Ciro Santilli, Making GitHub Delicious, Brandon High, Matt Jankowski, David Anson, Tobias Bengfort, Loic Nageleisen, Will Fleming, Jean-Christophe Gay, sudodoki, David Rodríguez, Garth Braithwaite, Alexander Köplinger, Simon Symeonidis, Jakub Wilk, Eitan Adler, David Rodríguez, Phil Dibowitz, David Somers-Harris, copperwalls, John Trammell, Waylan Limberg, Ash, Paul B, Andrew Janke, Adam Strickland, Naomi Reeves, Olle Jonsson, Lauritz Hilsøe, Andrew Janke Roman Kolesnev, Alex Harvey, Tim Smith, Tim Smith, tsuburin, Mikael Kjaer, Caleb Buxton, Mark E. Schill, Waldir Pimenta, Ben van B, Jose Angel Pardillo Vela, androidseb, jtcarnes, Gene Gotimer, Sami Ahmed Siddiqui, Karol Babioch, Eric Knibbe, Alexander Jaust, orviz, Lennart Jern, Benjamin Quorning, Ting Chen, Kai, adamroyjones, Bengt Lüers, JP Hastings-Spital

LICENSE

MIT

REPORTING BUGS

Report bugs to and suggest improvements on the project page,
https://github.com/markdownlint/markdownlint

VERSION

This is about markdownlint version 0.12.0 (October 18th, 2022).

February 1, 2023