xref: /freebsd/crypto/openssl/util/markdownlint.rb (revision 3f0efe05432b1633991114ca4ca330102a561959)
1# markdownlint style rules for OpenSSL
2# See https://github.com/markdownlint/markdownlint/blob/master/docs/RULES.md
3
4all
5
6# Use --- and === for H1 and H2.
7rule 'MD003', :style => :setext_with_atx
8# Code blocks may be fenced or indented, both are OK...
9# but they must be consistent throughout each file.
10rule 'MD046', :style => :consistent
11
12# Bug in mdl, https://github.com/markdownlint/markdownlint/issues/313
13exclude_rule 'MD007'
14
15exclude_rule 'MD004' # Unordered list style TODO(fix?)
16exclude_rule 'MD005' # Inconsistent indentation for list items at the same level
17exclude_rule 'MD006' # Consider starting bulleted lists at the beginning of the line
18exclude_rule 'MD014' # Dollar signs used before commands without showing output
19exclude_rule 'MD023' # Headers must start at the beginning of the line
20exclude_rule 'MD024' # Multiple headers with the same content
21exclude_rule 'MD025' # Multiple top level headers in the same document
22exclude_rule 'MD026' # Trailing punctuation in header
23exclude_rule 'MD029' # Ordered list item prefix
24exclude_rule 'MD030' # Spaces after list markers (default: 1!)
25