Add markdown lint

.github/ISSUE_TEMPLATE/bug_report.md

@@ -7,32 +7,37 @@ assignees: ''
 
 ---
 
-**What happened?**
+## What happened?
+
 A clear and concise description of what the bug is.
 
-**What did you expect to happen?**
+## What did you expect to happen?
+
 A clear and concise description of what you expected to happen.
 
-**How can we reproduce the behavior you experienced?**
+## How can we reproduce the behavior you experienced?
+
 Steps to reproduce the behavior:
+
 1. Step 1
 2. Step 2
 3. Step 3
 4. Step 4
 
 In case this is related to specific markdown, please provide a minimal markdown example here.
 
-**Information (please complete the following information)**
+## Further Information (please complete the following information)
 
- - Mark Version (`mark --version`): [e.g. v9.1.4]
- - Mark Parameters: [e.g. `--drop-h1 --title-from-h1`]
- - Confluence Hosting: [e.g. Cloud, Server or Datacenter]
- - Confluence Version: [e.g. v7.13]
- - Environment specific Information: [e.g. running in Github Actions, or on Mac OS X, etc.]
+* Mark Version (`mark --version`): [e.g. v9.1.4]
+* Mark Parameters: [e.g. `--drop-h1 --title-from-h1`]
+* Confluence Hosting: [e.g. Cloud, Server or Datacenter]
+* Confluence Version: [e.g. v7.13]
+* Environment specific Information: [e.g. running in Github Actions, or on Mac OS X, etc.]
+
+## Logs or other output
 
-**Logs or other output**
 Please provide logs, other kind of output here.
 
-**Additional context**
-Add any other context about the problem here.
+## Additional context
 
+Add any other context about the problem here.

.github/workflows/ci.yml

@@ -31,6 +31,16 @@ jobs:
     - name: golangci-lint
       uses: golangci/golangci-lint-action@v3
 
+  # Runs markdown-lint on the markdown files
+  ci-markdown-lint:
+    name: ci-markdown-lint
+    runs-on: ubuntu-latest
+    steps:
+    - name: Check out code into the Go module directory
+      uses: actions/checkout@v4
+    - name: markdownlint-cli2-action
+      uses: DavidAnson/markdownlint-cli2-action@v14
+
   # Executes Unit Tests
   ci-unit-tests:
     name: ci-unit-tests

.markdownlint-cli2.jsonc

@@ -0,0 +1,19 @@
+{
+  "globs": [
+    "*.md",
+    ".github/**/*.md"
+  ],
+
+  // ToDo: Following rules can't be fixed automatically. They should be enabled when fixed.
+  "config": {
+    "MD004": {
+      "style": "asterisk"
+    },
+    "MD013": false, // https://github.com/markdownlint/markdownlint/blob/main/docs/RULES.md#md013---line-length
+    //"MD024": false, // https://github.com/markdownlint/markdownlint/blob/main/docs/RULES.md#md024---multiple-headers-with-the-same-content
+    "MD033": false, // https://github.com/markdownlint/markdownlint/blob/main/docs/RULES.md#md033---inline-html
+    //"MD036": false, // https://github.com/markdownlint/markdownlint/blob/main/docs/RULES.md#md036---emphasis-used-instead-of-a-header
+    "MD040": false, // https://github.com/markdownlint/markdownlint/blob/main/docs/RULES.md#md040---fenced-code-blocks-should-have-a-language-specified
+    "MD041": false // https://github.com/markdownlint/markdownlint/blob/main/docs/RULES.md#md041---first-line-in-file-should-be-a-top-level-header 
+  }
+}