diff --git a/.markdownlint-cli2.yaml b/.markdownlint-cli2.yaml new file mode 100644 index 0000000000000..090d660d718fe --- /dev/null +++ b/.markdownlint-cli2.yaml @@ -0,0 +1,11 @@ +# Configuration for the markdownlint-cli2, see: +# https://github.com/DavidAnson/markdownlint-cli2/blob/main/test/markdownlint-cli2-yaml-example/.markdownlint-cli2.yaml + +globs: + - "**/*.md" +ignores: + - "**/node_modules/**" + - "**/projects/external/**" + - "**/multi-kotlin-project/**" + - "**/sbt-http4s-template/**" + - "**/stack-yesodweb-simple/**" diff --git a/.markdownlint.yaml b/.markdownlint.yaml new file mode 100644 index 0000000000000..c8177bba05ac0 --- /dev/null +++ b/.markdownlint.yaml @@ -0,0 +1,35 @@ +# Markdownlint configuration, see: https://github.com/DavidAnson/markdownlint/blob/main/schema/.markdownlint.yaml +# For the list of rules see: https://github.com/DavidAnson/markdownlint/blob/main/README.md#rules--aliases + +# ul-style +MD004: + style: asterisk + +# line-length +MD013: + code_blocks: false + line_length: 120 + tables: false + +# no-duplicate-heading +MD024: false # GitHub has no issues with anchors for headings with the same content. + +# no-inline-html +MD033: false # Inline HTML is used for anchors in README.md where images are used in headings. + +# no-bare-urls +MD034: false # GitHub has no issues with rendering bare URLs. + +# fenced-code-language +MD040: false # It is not possible to always set a language, for example in case of config files using uncommon formats. + +# first-line-heading +MD041: false # Some short README.md files do not require a heading. + +# code-block-style +MD046: + style: fenced + +# emphasis-style +MD049: + style: asterisk