Skip to content

Commit

Permalink
Add .markdownlint
Browse files Browse the repository at this point in the history
  • Loading branch information
koppor committed Aug 29, 2024
1 parent 3b2c094 commit fc62068
Showing 1 changed file with 19 additions and 0 deletions.
19 changes: 19 additions & 0 deletions docs/adr/.markdownlint
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
default: true

# Allow arbitrary line length
#
# Reason: We apply the one-sentence-per-line rule. A sentence may get longer than 80 characters, especially if links are contained.
#
# Details: https://github.com/DavidAnson/markdownlint/blob/main/doc/Rules.md#md013---line-length
MD013: false

# Allow duplicate headings
#
# Reasons:
#
# - The chosen option is considerably often used as title of the ADR (e.g., ADR-0015). Thus, that title repeats.
# - We use "Examples" multiple times (e.g., ADR-0010).
# - Markdown lint should support the user and not annoy them.
#
# Details: https://github.com/DavidAnson/markdownlint/blob/main/doc/Rules.md#md024---multiple-headings-with-the-same-content
MD024: false

0 comments on commit fc62068

Please sign in to comment.