Add GitHub Super Linter w/ markdownlint as a GitHub Action (#93)

Signed-off-by: Randall <[email protected]>

Signed-off-by: Randall <[email protected]>

Author: ran-dall

.github/linters/.markdown-lint.yml

@@ -0,0 +1,18 @@
+# Default state for all rules
+default: true
+# "~MD013/line-length"
+MD013: false
+# "~MD025/single-title/single-h1"
+MD025: false
+# "~MD036/no-emphasis-as-heading"
+MD036: false
+# "~MD033/no-inline-html"
+MD033: false
+# "~MD049/emphasis-style"
+MD049: false
+# "~MD012/no-multiple-blank"
+MD012: false
+# "~MD024/no-duplicate-heading/no-duplicate-header"
+MD024: false
+# "~MD001/heading-increment/header-increment"
+MD001: false

.github/workflows/linter.yml

@@ -0,0 +1,53 @@
+---
+#################################
+#################################
+## Super Linter GitHub Actions ##
+#################################
+#################################
+name: Lint Code Base
+
+#############################
+# Start the job on all push #
+#############################
+on:
+  push:
+    branches-ignore: [master, main]
+    # Remove the line above to run when pushing to master
+  pull_request:
+    branches: [master, main]
+
+###############
+# Set the Job #
+###############
+jobs:
+  build:
+    # Name the Job
+    name: Lint Code Base
+    # Set the agent to run on
+    runs-on: ubuntu-latest
+
+    ##################
+    # Load all steps #
+    ##################
+    steps:
+      ##########################
+      # Checkout the code base #
+      ##########################
+      - name: Checkout Code
+        uses: actions/checkout@v3
+        with:
+          # Full git history is needed to get a proper
+          # list of changed files within `super-linter`
+          fetch-depth: 0
+
+      #########################################
+      # Run Linter against new Markdown files #
+      #########################################
+      - name: Lint Markdown
+        uses: github/super-linter@v4
+        env:
+          VALIDATE_ALL_CODEBASE: false
+          DEFAULT_BRANCH: master
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          VALIDATE_MARKDOWN: true
+          MARKDOWN_CONFIG_FILE: .markdown-lint.yml