Merge pull request #8 from ashishb/ashishb/ci

ci: add Markdown linter

Author: ashishb

.github/workflows/lint-markdown.yaml

@@ -0,0 +1,51 @@
+# Generated by Gabo (https://github.com/ashishb/gabo)
+---
+# Run this locally with act - https://github.com/nektos/act
+# act -j lintMarkdown
+name: Lint Markdown
+
+on:  # yamllint disable-line rule:truthy
+  push:
+    branches: [main, master]
+    paths:
+      - "**.md"
+      - ".github/workflows/lint-markdown.yaml"
+  pull_request:
+    branches: [main, master]
+    paths:
+      - "**.md"
+      - ".github/workflows/lint-markdown.yaml"
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+# Ref: https://docs.github.com/en/actions/writing-workflows/choosing-what-your-workflow-does/controlling-permissions-for-github_token
+permissions:
+  contents: read
+
+jobs:
+  lintMarkdown:
+    runs-on: ubuntu-latest
+    timeout-minutes: 15
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+        with:
+          persist-credentials: false
+
+      - name: Set up Ruby
+        # See https://github.com/ruby/setup-ruby#versioning
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: 3.0
+
+      - name: Install dependencies
+        run: gem install mdl
+
+      - name: Run tests
+        # Rule list: https://github.com/markdownlint/markdownlint/blob/main/docs/RULES.md
+        # Don't check for line length (MD013)
+        # Don't care about list ordering (MD029)
+        run: mdl --git-recurse --rules ~MD013,~MD029 .

FakeApps/README.md

@@ -1,5 +1,7 @@
 # FakeApps
+
 Theses are in 3 categories:
+
 - ``does nothing`` apps
 - ``impersonator app`` apps
 - ``real app but with malicious code`` apps