Merge pull request satwikkansal#354 from nifadyev/feature/satwikkansal#347/configure-markdown-linter-and-formatter

satwikkansal#347: Add markdownlint-cli2 as Github Action and pre-commit hook

Author: satwikkansal

.github/workflows/pr.yml

@@ -0,0 +1,17 @@
+on: [pull_request]
+
+permissions:
+  contents: read
+  pull-requests: read
+  checks: write
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v4
+    - uses: DavidAnson/markdownlint-cli2-action@v17

.markdownlint.yaml

@@ -0,0 +1,15 @@
+# MD013/line-length
+MD013:
+  line_length: 120
+
+# no-duplicate-heading - Multiple headings with the same content (Ignore multiple `Explanation` headings)
+MD024: false
+
+# no-trailing-punctuation - Trailing punctuation in heading (Ignore exclamation marks in headings)
+MD026: false
+
+# no-inline-html : Inline HTML (HTML is used for centered and theme specific images)
+MD033: false
+
+# no-inline-html : Bare URL used (site should be attributed transparently, because otherwise we have to un-necesarily explain where the link directs)
+MD034: false

.pre-commit-config.yaml

@@ -0,0 +1,7 @@
+default_language_version:
+    python: python3.12
+repos:
+-   repo: https://github.com/DavidAnson/markdownlint-cli2
+    rev: v0.14.0
+    hooks:
+    -   id: markdownlint-cli2