[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 may be fenced or indented, both are OK...
# but they must be consistent throughout each file.
rule 'MD046', :style => :consistent
# Not possible to line-break tables.
rule 'MD013', :tables => false

# 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
exclude_rule 'MD030' # Spaces after list markers (default: 1!)
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
fb2cd91f RL	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
ec36534c HL	11	# Not possible to line-break tables.
ec36534c HL	12	rule 'MD013', :tables => false
4ef0ddc9 RS	13
	14	# Bug in mdl, https://github.com/markdownlint/markdownlint/issues/313
	15	exclude_rule 'MD007'
	16
	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
915e7e75	21	exclude_rule 'MD023' # Headers must start at the beginning of the line
4ef0ddc9 RS	22	exclude_rule 'MD024' # Multiple headers with the same content
4ef0ddc9 RS	23	exclude_rule 'MD025' # Multiple top level headers in the same document
915e7e75	24	exclude_rule 'MD026' # Trailing punctuation in header
4ef0ddc9	25	exclude_rule 'MD029' # Ordered list item prefix
2046f80b	26	exclude_rule 'MD030' # Spaces after list markers (default: 1!)