]>
git.ipfire.org Git - thirdparty/openssl.git/blob - util/markdownlint.rb
1 # markdownlint style rules for OpenSSL
2 # See https://github.com/markdownlint/markdownlint/blob/master/docs/RULES.md
6 # Use --- and === for H1 and H2.
7 rule
'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.
10 rule
'MD046', :style => :consistent
11 # Not possible to line-break tables.
12 rule
'MD013', :tables => false
14 # Bug in mdl, https://github.com/markdownlint/markdownlint/issues/313
17 exclude_rule
'MD004' # Unordered list style TODO(fix?)
18 exclude_rule
'MD005' # Inconsistent indentation for list items at the same level
19 exclude_rule
'MD006' # Consider starting bulleted lists at the beginning of the line
20 exclude_rule
'MD014' # Dollar signs used before commands without showing output
21 exclude_rule
'MD023' # Headers must start at the beginning of the line
22 exclude_rule
'MD024' # Multiple headers with the same content
23 exclude_rule
'MD025' # Multiple top level headers in the same document
24 exclude_rule
'MD026' # Trailing punctuation in header
25 exclude_rule
'MD029' # Ordered list item prefix
26 exclude_rule
'MD030' # Spaces after list markers (default: 1!)