.markdownlint.yml

---
###########################
###########################
## Markdown Linter rules ##
###########################
###########################

# Linter rules doc:
# - https://github.com/DavidAnson/markdownlint/blob/main/doc/Rules.md
#
# Note:
# To comment out a single error:
#   <!-- markdownlint-disable -->
#   any violations you want
#   <!-- markdownlint-restore -->
#

# Default state for all rules
default: false

#################
# Rules by tags #
#################
blanks-around-fences: true    # Fenced code blocks should be surrounded by blank lines
blanks-around-headings: true  # Headings should be surrounded by blank lines
blanks-around-lists: true     # Lists should be surrounded by blank lines
code-block-style:
  style: "fenced"
code-fence-style:
  style: "backtick"
emphasis-style:
  style: "consistent"
fenced-code-language: true    # Fenced code blocks should have a language specified
heading-start-left: true      # Headings must start at the beginning of the line
heading-style:
  style: "atx"
hr-style: true                # Horizontal rule style
list-indent: true             # Inconsistent indentation for list items at the same level
no-empty-links: true
no-missing-space-atx: true    # No space after hash on atx style heading
no-multiple-blanks: true      # Multiple consecutive blank lines
no-reversed-links: true
no-space-in-code: true
no-space-in-emphasis: true
no-space-in-links: true
no-trailing-spaces: true
single-trailing-newline: true   # Files should end with a single newline character
strong-style:
  style: "consistent"
ul-style:
  style: "consistent"