Merge pull request #140 from Decompollaborate/develop

1.17.4

.github/workflows/md_lint.yml

@@ -0,0 +1,17 @@
+name: Lint markdown files
+
+# Build on every branch push, tag push, and pull request change:
+on: [push, pull_request]
+
+jobs:
+  checks:
+    runs-on: ubuntu-latest
+    name: Lint md files
+    steps:
+    - name: Checkout repository
+      uses: actions/checkout@v4
+
+    - name: Lint markdown files
+      uses: articulate/actions-markdownlint@v1.1.0
+      with:
+        config: .markdownlint.jsonc

.gitignore

@@ -162,7 +162,8 @@ cython_debug/
 #.idea/
 
 # Text editor remnants
-.vscode/
+.vscode/*
+!.vscode/extensions.json
 .vs/
 .idea/
 CMakeLists.txt

.markdownlint.jsonc

@@ -0,0 +1,14 @@
+{
+    // https://github.com/DavidAnson/markdownlint/blob/main/doc/md024.md
+    // MD024 - Multiple headings with the same content
+    "MD024": {
+        "siblings_only": true
+    },
+
+    // https://github.com/DavidAnson/markdownlint/blob/main/doc/md013.md
+    // MD013 - Line length
+    "MD013": {
+        "code_block_line_length": 120,
+        "headings": false
+    }
+}

.vscode/extensions.json

@@ -0,0 +1,7 @@
+{
+    // See https://go.microsoft.com/fwlink/?LinkId=827846
+    // for the documentation about the extensions.json format
+    "recommendations": [
+        "davidanson.vscode-markdownlint"
+    ]
+}