summaryrefslogtreecommitdiff
path: root/util/markdownlint.rb
blob: 64a82e36848a4f1309d285f150fe430df6e56330 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
# markdownlint style rules for OpenSSL
# See https://github.com/markdownlint/markdownlint/blob/master/docs/RULES.md

all

# Use --- and === for H1 and H2.
rule 'MD003', :style => :setext_with_atx
# Code blocks are indented
rule 'MD046', :style => :indented

# Bug in mdl, https://github.com/markdownlint/markdownlint/issues/313
exclude_rule 'MD007'

exclude_rule 'MD004' # Unordered list style TODO(fix?)
exclude_rule 'MD005' # Inconsistent indentation for list items at the same level
exclude_rule 'MD006' # Consider starting bulleted lists at the beginning of the line
exclude_rule 'MD014' # Dollar signs used before commands without showing output
exclude_rule 'MD023' # Headers must start at the beginning of the line
exclude_rule 'MD024' # Multiple headers with the same content
exclude_rule 'MD025' # Multiple top level headers in the same document
exclude_rule 'MD026' # Trailing punctuation in header
exclude_rule 'MD029' # Ordered list item prefix