2021-10-06 11:18:27 +02:00
|
|
|
# Rules for <https://github.com/markdownlint/markdownlint>
|
|
|
|
|
|
2021-09-09 15:52:24 +02:00
|
|
|
# Load all rules by default
|
|
|
|
|
all
|
|
|
|
|
|
|
|
|
|
#
|
|
|
|
|
# Tweak rules
|
|
|
|
|
#
|
|
|
|
|
|
|
|
|
|
# MD002 First header should be a top level header
|
|
|
|
|
# Because we use HTML to hide them on the website.
|
|
|
|
|
exclude_rule 'MD002'
|
|
|
|
|
|
|
|
|
|
# MD013 Line length
|
|
|
|
|
exclude_rule 'MD013'
|
|
|
|
|
|
|
|
|
|
# MD014 Dollar signs used before commands without showing output
|
|
|
|
|
exclude_rule 'MD014'
|
|
|
|
|
|
|
|
|
|
# Tell the linter to use ordered lists:
|
|
|
|
|
# 1. Foo
|
|
|
|
|
# 2. Bar
|
|
|
|
|
# 3. Baz
|
|
|
|
|
#
|
|
|
|
|
# Instead of:
|
|
|
|
|
# 1. Foo
|
|
|
|
|
# 1. Bar
|
|
|
|
|
# 1. Baz
|
|
|
|
|
rule 'MD029', :style => :ordered
|
|
|
|
|
|
|
|
|
|
# MD033 Inline HTML
|
|
|
|
|
# TODO: Tweak elements when https://github.com/markdownlint/markdownlint/issues/118 will be done?
|
|
|
|
|
exclude_rule 'MD033'
|
|
|
|
|
|
|
|
|
|
# MD034 Bare URL used
|
|
|
|
|
# TODO: Remove when https://github.com/markdownlint/markdownlint/issues/328 will be fixed.
|
|
|
|
|
exclude_rule 'MD034'
|
|
|
|
|
|
|
|
|
|
# MD041 First line in file should be a top level header
|
|
|
|
|
# Because we use HTML to hide them on the website.
|
|
|
|
|
exclude_rule 'MD041'
|
