diff -Nru ruby-mdl-0.13.0/debian/changelog ruby-mdl-0.13.0/debian/changelog --- ruby-mdl-0.13.0/debian/changelog 2023-11-13 14:27:50.000000000 +0000 +++ ruby-mdl-0.13.0/debian/changelog 2023-11-21 16:48:14.000000000 +0000 @@ -1,3 +1,10 @@ +ruby-mdl (0.13.0-4) unstable; urgency=medium + + * lint control file + * improve manpage by provision of examples of application + + -- Norwid Behrnd Tue, 21 Nov 2023 17:48:14 +0100 + ruby-mdl (0.13.0-3) unstable; urgency=medium * address manpage problem diff -Nru ruby-mdl-0.13.0/debian/control ruby-mdl-0.13.0/debian/control --- ruby-mdl-0.13.0/debian/control 2023-11-13 14:27:50.000000000 +0000 +++ ruby-mdl-0.13.0/debian/control 2023-11-21 16:48:14.000000000 +0000 @@ -39,5 +39,3 @@ Section: oldlibs Description: Markdown lint tool - transitional dummy package This is a transitional package for markdownlint. It can be safely removed. - After removal of this binary, consider to rebuild the local manpage database - by `sudo mandb -c` (which eventually is read e.g., by `apropos`). diff -Nru ruby-mdl-0.13.0/debian/markdownlint.1 ruby-mdl-0.13.0/debian/markdownlint.1 --- ruby-mdl-0.13.0/debian/markdownlint.1 2023-11-13 14:27:50.000000000 +0000 +++ ruby-mdl-0.13.0/debian/markdownlint.1 2023-11-21 16:48:14.000000000 +0000 @@ -2,7 +2,7 @@ .\"http://sourceforge.net/projects/gmanedit2 .\"Replace with the program name, x with the Section Number -.TH MARKDOWNLINT 1 "November 1, 2023" "" "General Commands Manual" +.TH MARKDOWNLINT 1 "November 21, 2023" "" "General Commands Manual" .SH NAME markdownlint \- Markdown lint tool @@ -51,6 +51,73 @@ .IP \-V,\ \--version Show version +.SH EXAMPLES +List the objectives of rules MD012, MD022, MD031 and MD032: +.IP +.EX +mdl -r MD012,MD022,MD031,MD032 -l +.EE +.PP +Scrutinize file example.md only by rules MD012, MD022, MD031 and MD032: +.IP +.EX +mdl -r MD012,MD022,MD031,MD032 ./example.md +.EE +.PP +Scrutinize file example.md by all rules available except MD033 and +MD034: +.IP +.EX +mdl -r \[ti]MD033,\[ti]MD034 ./example.md +.EE +.PP +List all rules associated to the tag \f[I]indentation\f[R]: +.IP +.EX +mdl -t indentation -l +.EE +.PP +Scrutinize file example.md by all rules without tag +\f[I]indentation\f[R]: +.IP +.EX +mdl -t \[ti]indentation ./example.md +.EE +.PP +By default, markdownlint reports sort the issues by their rule. +With GNU coreutils, your shell may resort the output by the +corresponding line number of the file: +.IP +.EX +mdl ./example.md | sort -t \[dq]:\[dq] -k 2 -n +.EE +.PP +Recurrent (personalized) check criteria can be saved as a style. +Snippet \f[I]mystyle.rb\f[R] below showcases the keywords for comments, +rules, tags, as well as the general syntax available: +.IP +.EX +all # initiate with all rules implemented + +rule \[aq]MD013\[aq], :line_length => 100, :ignore_code_blocks => true +exclude_rule \[aq]MD014\[aq] + +# tag :blockquote +exclude_tag :indentation +.EE +.PP +Rules a style file activates can be listed by +.IP +.EX +mdl -s ./mystyle.rb -l +.EE +.PP +A personalized local style is applied during a check by markdownlint by +.IP +.EX +mdl -s ./mystyle.rb ./example.md +.EE + .SH AUTHOR Mark Harrison, Ciro Santilli, Making GitHub Delicious, Brandon High, Matt Jankowski, David Anson, Tobias Bengfort, Loic Nageleisen, Will