From de41ed5d3196a9b8f97b9d7b246c43644267a179 Mon Sep 17 00:00:00 2001
From: martincostello <martin@martincostello.com>
Date: Sat, 28 Sep 2024 14:04:23 +0100
Subject: [PATCH] Add markdownlint

Add a Markdown linter.
---
 .github/ISSUE_TEMPLATE.md                 | 1 +
 .github/ISSUE_TEMPLATE/bug_report.md      | 1 +
 .github/ISSUE_TEMPLATE/feature_request.md | 3 ++-
 .github/workflows/lint.yml                | 7 +++++++
 .markdownlint.json                        | 4 ++++
 5 files changed, 15 insertions(+), 1 deletion(-)
 create mode 100644 .markdownlint.json

diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md
index ff658046..5f2a1b38 100644
--- a/.github/ISSUE_TEMPLATE.md
+++ b/.github/ISSUE_TEMPLATE.md
@@ -1,3 +1,4 @@
+<!-- markdownlint-disable MD041 -->
 ### Expected behaviour
 
 <!-- Explain what you expected to happen. -->
diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md
index c7847dd2..b7ada38b 100644
--- a/.github/ISSUE_TEMPLATE/bug_report.md
+++ b/.github/ISSUE_TEMPLATE/bug_report.md
@@ -2,6 +2,7 @@
 name: Bug report
 about: Create a bug report to help us improve the library
 labels: bug
+title: ''
 ---
 
 ### Describe the bug
diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md
index 9ec65944..01c8edab 100644
--- a/.github/ISSUE_TEMPLATE/feature_request.md
+++ b/.github/ISSUE_TEMPLATE/feature_request.md
@@ -2,9 +2,10 @@
 name: Feature request
 about: Suggest an idea for a feature of this library
 labels: feature-request
+title: ''
 ---
 
-### Is your feature request related to a problem? Please describe.
+### Is your feature request related to a problem?
 
 <!--
 A clear and concise description of what the problem is. For example: _It would be useful if [...]_
diff --git a/.github/workflows/lint.yml b/.github/workflows/lint.yml
index 747bbf3c..05735159 100644
--- a/.github/workflows/lint.yml
+++ b/.github/workflows/lint.yml
@@ -37,3 +37,10 @@ jobs:
       uses: docker://rhysd/actionlint@sha256:89d3f90f82781dee3c8724651129634b08cf2241bbd67fcd02a1c5198119fc5e # v1.7.2
       with:
         args: -color
+
+    - name: Lint markdown
+      uses: DavidAnson/markdownlint-cli2-action@db43aef879112c3119a410d69f66701e0d530809 # v17.0.0
+      with:
+        config: '.markdownlint.json'
+        globs: |
+          **/*.md
diff --git a/.markdownlint.json b/.markdownlint.json
new file mode 100644
index 00000000..e8272ec3
--- /dev/null
+++ b/.markdownlint.json
@@ -0,0 +1,4 @@
+{
+  "MD013": false,
+  "MD040": false
+}