mirror of
https://github.com/openssl/openssl.git
synced 2025-01-30 14:01:55 +08:00
fb2cd91f27
We use both indented and fenced styles in diverse markdown files. We try to do this consistently in each file, though. Reviewed-by: Matt Caswell <matt@openssl.org> Reviewed-by: Tomas Mraz <tomas@openssl.org> (Merged from https://github.com/openssl/openssl/pull/17933)
24 lines
1.0 KiB
Ruby
24 lines
1.0 KiB
Ruby
# 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
|
|
|
|
# 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
|