From fc62068829c691676fc2d418f5387db4794cdc7b Mon Sep 17 00:00:00 2001 From: Oliver Kopp Date: Thu, 29 Aug 2024 09:52:55 +0200 Subject: [PATCH] Add .markdownlint --- docs/adr/.markdownlint | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) create mode 100644 docs/adr/.markdownlint diff --git a/docs/adr/.markdownlint b/docs/adr/.markdownlint new file mode 100644 index 0000000..3c91e56 --- /dev/null +++ b/docs/adr/.markdownlint @@ -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