Add automated markdown linting (openhab#1415)

* Added Markdownlint action.

Signed-off-by: Jerome Luckenbach <[email protected]>

* Fix action yml file.

Signed-off-by: Jerome Luckenbach <[email protected]>

* Fix action yml file.

Signed-off-by: Jerome Luckenbach <[email protected]>

* Fix action yml file.

Signed-off-by: Jerome Luckenbach <[email protected]>

* Define proper run parameters and fix markdown styleguide aside.

Signed-off-by: Jerome Luckenbach <[email protected]>

* Leave out pull request triggers for the start.

Signed-off-by: Jerome Luckenbach <[email protected]>

Author: Confectrician

.github/markdownStyle.rb

@@ -0,0 +1,13 @@
+all
+
+# Expect dash usage for unorderd lists
+rule 'MD004', :style => :dash
+
+# Allow long line lengths
+exclude_rule 'MD013'
+
+# Allow Multiple top level headers in the same document
+exclude_rule 'MD025'
+
+# Allow inline HTML
+exclude_rule 'MD033'

.github/workflows/markdownlint.yml

@@ -0,0 +1,26 @@
+name: Linting
+
+on:
+  push:
+    branches:
+      - 'main'
+      - '2.5.x'
+    tags-ignore:
+      - '**'
+#  pull_request:
+#    branches:
+#      - main
+#    types: [open,synchronize,reopen]
+
+jobs:
+  markdownlint:
+    runs-on: ubuntu-latest
+    steps:
+
+      - name: Check out code
+        uses: actions/checkout@v2
+
+      - name: Run markdownlint (mdl)
+        uses: bewuethr/[email protected]
+        with:
+          style-file: .github/markdownStyle.rb

styleguide.md

@@ -16,7 +16,7 @@ First and foremost we are following the recommendations given at: [https://www.c
 An ordered list:
 
 1. Some text
-2. Some more text
+1. Some more text
 
 An unordered list:
 
@@ -25,9 +25,9 @@ An unordered list:
 
 An unordered loose list (applied if bigger or with nested lists):
 
--   Some text
-    - An indented item, making the list "loose"
+- Some text
+  - An indented item, making the list "loose"
 
--   Some more text
+- Some more text
 
--   And even more text that could also strech over multiple lines
+- And even more text that could also strech over multiple lines