2021-06-18 07:51:38 +00:00
|
|
|
---
|
|
|
|
|
2021-06-18 07:59:36 +00:00
|
|
|
# Default state for all rules
|
2021-06-18 07:51:38 +00:00
|
|
|
default: true
|
|
|
|
|
2021-06-18 07:59:36 +00:00
|
|
|
# MD003/heading-style/header-style - Heading style
|
2021-06-18 07:51:38 +00:00
|
|
|
MD003:
|
2021-06-18 07:59:36 +00:00
|
|
|
# Enforce the ATX-closed style of header
|
2021-06-18 07:51:38 +00:00
|
|
|
style: "atx_closed"
|
|
|
|
|
2021-06-18 07:59:36 +00:00
|
|
|
# MD004/ul-style - Unordered list style
|
2021-06-18 07:51:38 +00:00
|
|
|
MD004:
|
2021-06-18 07:59:36 +00:00
|
|
|
# Enforce dashes for unordered lists
|
2021-06-18 07:51:38 +00:00
|
|
|
style: "dash"
|
|
|
|
|
2021-06-18 07:59:36 +00:00
|
|
|
# MD013/line-length - Line length
|
2021-06-18 07:51:38 +00:00
|
|
|
MD013:
|
2021-06-18 07:59:36 +00:00
|
|
|
# Do not enforce for code blocks
|
2021-06-18 07:51:38 +00:00
|
|
|
code_blocks: false
|
2021-06-18 07:59:36 +00:00
|
|
|
# Do not enforce for tables
|
2021-06-18 07:51:38 +00:00
|
|
|
tables: false
|
|
|
|
|
2021-06-18 07:59:36 +00:00
|
|
|
# MD024/no-duplicate-heading/no-duplicate-header - Multiple headings with the
|
|
|
|
# same content
|
2021-06-18 07:51:38 +00:00
|
|
|
MD024:
|
2021-06-18 07:59:36 +00:00
|
|
|
# Allow headers with the same content as long as they are not in the same
|
|
|
|
# parent heading
|
2021-06-18 07:51:38 +00:00
|
|
|
allow_different_nesting: true
|
|
|
|
|
2021-06-18 07:59:36 +00:00
|
|
|
# MD029/ol-prefix - Ordered list item prefix
|
2021-06-18 07:51:38 +00:00
|
|
|
MD029:
|
2021-06-18 07:59:36 +00:00
|
|
|
# Enforce the `1.` style for ordered lists
|
2021-06-18 07:51:38 +00:00
|
|
|
style: "one"
|
|
|
|
|
2021-06-18 07:59:36 +00:00
|
|
|
# MD033/no-inline-html - Inline HTML
|
2021-06-18 07:51:38 +00:00
|
|
|
MD033:
|
2021-06-18 07:59:36 +00:00
|
|
|
# The h1 and img elements are allowed to permit header images
|
2021-06-18 07:51:38 +00:00
|
|
|
allowed_elements:
|
|
|
|
- h1
|
|
|
|
- img
|
2021-08-10 15:36:33 +00:00
|
|
|
|
|
|
|
# MD035/hr-style - Horizontal rule style
|
|
|
|
MD035:
|
|
|
|
# Enforce dashes for horizontal rules
|
|
|
|
style: "---"
|
2021-08-10 15:38:39 +00:00
|
|
|
|
2022-02-25 16:23:25 +00:00
|
|
|
# MD046/code-block-style - Code block style
|
2021-08-10 15:38:39 +00:00
|
|
|
MD046:
|
|
|
|
# Enforce the fenced style for code blocks
|
|
|
|
style: "fenced"
|
2022-02-25 16:21:37 +00:00
|
|
|
|
|
|
|
# MD049/emphasis-style - Emphasis style should be consistent
|
|
|
|
MD049:
|
|
|
|
# Enforce asterisks as the style to use for emphasis
|
|
|
|
style: "asterisk"
|
|
|
|
|
|
|
|
# MD050/strong-style - Strong style should be consistent
|
|
|
|
MD050:
|
|
|
|
# Enforce asterisks as the style to use for strong
|
|
|
|
style: "asterisk"
|