ci: add a workflow to validate links in Markdown files (#41)

.github/workflows/check-links.yml

@@ -0,0 +1,20 @@
+---
+name: Markdown Links Validation
+
+on: [push, workflow_dispatch]
+
+jobs:
+  markdown-link-check:
+    runs-on: ubuntu-latest
+    steps:
+
+      - name: Checkout this repository
+        uses: actions/[email protected]
+
+      - name: Validate Links in Markdown files
+        if: always()
+        uses: gaurav-nelson/[email protected]
+        with:
+          config-file: '.markdownlinkcheck.json'
+          use-quiet-mode: 'yes'
+          file-extension: .md

.markdownlinkcheck.json

@@ -0,0 +1,70 @@
+{
+	"ignorePatterns": [
+		{
+			"pattern": "^https://www.linkedin.com.*"
+		},
+		{
+			"pattern": ".*\\]$"
+		},
+		{
+			"pattern": "https://www.enterprisetimes.co.uk*"
+		},
+		{
+			"pattern": "https://www.pexels.com*"
+		},
+		{
+			"pattern": "https://www.pngrepo.com"
+		},
+		{
+			"pattern": "https://tdwi.org*"
+		},
+		{
+			"pattern": "https://www.fakepersongenerator.com*"
+		},
+		{
+			"pattern": "https://dash.readme.com*"
+		},
+		{
+			"pattern": "https://cfpland.com*"
+		},
+		{
+			"pattern": "https://n8n.io*"
+		},
+		{
+			"pattern": "https://confs.tech*"
+		},
+		{
+			"pattern": "https://businesswire.com*"
+		},
+		{
+			"pattern": "https://www.tmcnet.com*"
+		},
+		{
+			"pattern": "https://.*kubefirst.dev*"
+		},
+		{
+			"pattern": "http://localhost*"
+		},
+		{
+			"pattern": "https://gitlab.com*"
+		},
+		{
+			"pattern": "https://.*vultr.com*"
+		}
+	],
+	"replacementPatterns": [
+		{
+			"pattern": "{require(\"(*)\").default}",
+			"replacement": "*"
+		},
+		{
+		  "pattern": "^/img/*",
+		  "replacement": "/static/img/*"
+		}
+	],
+  "timeout": "30s",
+  "retryOn429": true,
+  "retryCount": 2,
+  "fallbackRetryDelay": "1m",
+  "aliveStatusCodes": [200, 429]
+}