.markdownlint.yaml

# markdownlint configuration
# the definitive list of rules for markdownlint can be found:
# https://github.com/DavidAnson/markdownlint/blob/main/doc/Rules.md
#
# only deviations from the defaults are noted here or where there's an opinion
# being expressed.

# default state for all rules
default:
  true

# heading style
MD003:
  style: "atx"

# unordered list style
MD004:
  style: "dash"

# unorderd list indentation (2-spaces)
# keep it tight yo!
MD007:
  indent: 2

# line length
MD013:
  line_length: 140
  code_block_line_length: 450
  tables: false

# multiple headings with the same content
# siblings_only is set here to allow for common header values in structured
# documents
MD024:
  siblings_only: true

# fenced code  should be surrounded by blank lines default: true
MD031:
  true

# lists should be surrounded by blank lines default: true
MD032:
  true

# MD033/no-inline-html - Inline HTML
MD033:
 allowed_elements: [ "br", "code", "details", "p", "pre", "span", "summary" ]

# bare URL - bare URLs shoudl be wrapped in angle brackets
# <https://eos.arista.com>
MD034:
  false

# horizontal rule style default: consistent
MD035:
  style: "---"

# first line in a file to be a top-level heading
# since we're using front-matter, this
MD041:
  false


# proper-names - proper names to have the correct capitalization
# probably not entirely helpful in a technical writing environment.
MD044:
  false

# block style - default: consistent
MD046:
  fenced