.markdownlint-cli2.yaml

# SPDX-FileCopyrightText: Copyright (c) 2017-2024 slowtec GmbH <post@slowtec.de>
# SPDX-License-Identifier: CC0-1.0

# Disable some built-in rules
config:
  default: true

  # The same headline in different nested sections is okay (and necessary for
  # CHANGELOG.md).
  no-duplicate-header:
    allow_different_nesting: true

  # We use ordered lists to make stuff easier to read in a text editor.
  ol-prefix:
    style: ordered

  # Not wrapping long lines makes diffs easier to read, especially for prose.
  # Instead, we should follow the "one sentence per line" pattern.
  line-length: false

  # Dollar signs are useful to indicate shell commands/type and help
  # distinguishing wrapped lines from new commands.
  commands-show-output: false

  # Indented code blocks are easier to read in a text editor, but don't allow
  # specifying a language for syntax highlighting. Therefore both indented and
  # fenced code block should be allowed depending on the use case.
  code-block-style: false

  # MD024/no-duplicate-heading: Multiple headings with the same content
  # Used in CHANGELOG.md
  no-duplicate-heading: false

  # MD026/no-trailing-punctuation: Trailing punctuation in heading
  # Used in README.md
  no-trailing-punctuation: false

# Fix any fixable errors
fix: true

# Disable inline config comments
noInlineConfig: true

# Disable progress on stdout (only valid at root)
noProgress: true