[thirdparty/openssl.git] / util / markdownlint.rb

# 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
Commit	Line	Data
4ef0ddc9 RS	1	# markdownlint style rules for OpenSSL
	2	# See https://github.com/markdownlint/markdownlint/blob/master/docs/RULES.md
	3
	4	all
	5
	6	# Use --- and === for H1 and H2.
	7	rule 'MD003', :style => :setext_with_atx
	8	# Code blocks are indented
	9	rule 'MD046', :style => :indented
	10
	11	# Bug in mdl, https://github.com/markdownlint/markdownlint/issues/313
	12	exclude_rule 'MD007'
	13
	14	exclude_rule 'MD004' # Unordered list style TODO(fix?)
	15	exclude_rule 'MD005' # Inconsistent indentation for list items at the same level
	16	exclude_rule 'MD006' # Consider starting bulleted lists at the beginning of the line
	17	exclude_rule 'MD014' # Dollar signs used before commands without showing output
915e7e75	18	exclude_rule 'MD023' # Headers must start at the beginning of the line
4ef0ddc9 RS	19	exclude_rule 'MD024' # Multiple headers with the same content
4ef0ddc9 RS	20	exclude_rule 'MD025' # Multiple top level headers in the same document
915e7e75	21	exclude_rule 'MD026' # Trailing punctuation in header
4ef0ddc9	22	exclude_rule 'MD029' # Ordered list item prefix