util/markdownlint.rb: Allow fenced code blocks
authorRichard Levitte <levitte@openssl.org>
Mon, 21 Mar 2022 15:23:09 +0000 (16:23 +0100)
committerTomas Mraz <tomas@openssl.org>
Wed, 23 Mar 2022 08:11:32 +0000 (09:11 +0100)
We use both indented and fenced styles in diverse markdown files.
We try to do this consistently in each file, though.

Reviewed-by: Matt Caswell <matt@openssl.org>
Reviewed-by: Tomas Mraz <tomas@openssl.org>
(Merged from https://github.com/openssl/openssl/pull/17933)

util/markdownlint.rb

index 64a82e36848a4f1309d285f150fe430df6e56330..159bf20870ec578e31912f6a7b32ef040b85dd8c 100644 (file)
@@ -5,8 +5,9 @@ all
 
 # Use --- and === for H1 and H2.
 rule 'MD003', :style => :setext_with_atx
-# Code blocks are indented
-rule 'MD046', :style => :indented
+# Code blocks may be fenced or indented, both are OK...
+# but they must be consistent throughout each file.
+rule 'MD046', :style => :consistent
 
 # Bug in mdl, https://github.com/markdownlint/markdownlint/issues/313
 exclude_rule 'MD007'