Martin L Roth has uploaded this change for review. ( https://review.coreboot.org/c/coreboot/+/63805 )
Change subject: Documentation: Add mdl style file ......................................................................
Documentation: Add mdl style file
This adds a style file for the markdown linter mdl.
The tool can be found on archive.org at the URL: https://web.archive.org/web/20220407032312/https://github.com/markdownlint/m...
This does 2 things: - Sets that line length limit to 72 characters as requested in the docs about writing the documentation.
- Excludes several rules that were added for a particular markdown parser. My opinion is that these rules make the text versions of the markdown harder to read.
To use this style file, run: $ mdl -s Documentation/.mdl_style.rb
Signed-off-by: Martin Roth gaumless@gmail.com Change-Id: I98289492ae3e920d440f0e5c308a3590fb89d9fd --- A Documentation/.mdl_style.rb 1 file changed, 9 insertions(+), 0 deletions(-)
git pull ssh://review.coreboot.org:29418/coreboot refs/changes/05/63805/1
diff --git a/Documentation/.mdl_style.rb b/Documentation/.mdl_style.rb new file mode 100644 index 0000000..a02a64c --- /dev/null +++ b/Documentation/.mdl_style.rb @@ -0,0 +1,9 @@ +# See one of the following URLs for explanations of all the rules +# https://github.com/markdownlint/markdownlint/blob/master/docs/RULES.md +# https://web.archive.org/web/20220424164542/https://github.com/markdownlint/m... + +all +exclude_rule 'no-multiple-blanks' +exclude_rule 'blanks-around-headers' +exclude_rule 'blanks-around-lists' +rule 'line-length', :line_length => 72