Merge pull request #37 from VGVentures/chore/markdown-quality

chore: markdown lint, link check, fix lint errors & update emojis

.github/workflows/deploy.yml

@@ -1,4 +1,4 @@
-name: Deploy to GitHub Pages
+name: 🌎 Deploy to GitHub Pages
 
 on:
   # Trigger the workflow every time you push to the `main` branch

.github/workflows/markdown_links.yml

@@ -0,0 +1,12 @@
+name: 🔗 Markdown Link Check
+
+on: push
+
+jobs:
+  markdown-link-check:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@master
+      - uses: gaurav-nelson/github-action-markdown-link-check@v1
+        with:
+          folder-path: src/

.github/workflows/markdown_lint.yml

@@ -0,0 +1,21 @@
+name: 👀 Markdown Lint Check
+
+on: push
+
+jobs:
+  markdown-lint:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout your repository using git
+        uses: actions/checkout@v4
+
+      - name: Install Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: 22
+
+      - name: Install dependencies
+        run: npm install
+
+      - name: Run Markdown Lint
+        run: npm run lint

.mdlintrc

@@ -0,0 +1,7 @@
+{
+  "$schema": "https://raw.githubusercontent.com/DavidAnson/markdownlint/v0.34.0/schema/markdownlint-config-schema.json",
+  "default": true,
+  "no-inline-html": false,
+  "line-length": false,
+  "no-duplicate-heading": false
+}

.vscode/extensions.json

@@ -2,6 +2,7 @@
   "recommendations": [
     "astro-build.astro-vscode",
     "bradlc.vscode-tailwindcss",
+    "DavidAnson.vscode-markdownlint",
     "unifiedjs.vscode-mdx"
   ],
   "unwantedRecommendations": []

.vscode/settings.json

@@ -36,6 +36,9 @@
     "**/*.tsx",
     "**/*.json"
   ],
+  "markdownlint.config": {
+    "MD024": false
+  },
   "tailwindCSS.includeLanguages": {
     "plaintext": "html"
   }

cspell.json

@@ -1,12 +1,25 @@
 {
-  "ignorePaths": ["node_modules/**", ".**/"],
-  "files": ["**/*.md", "**/*.mdx", "**/*.tsx", "**/*.ts", "**/*.json"],
+  "ignorePaths": [
+    "node_modules/**",
+    ".**/"
+  ],
+  "files": [
+    "**/*.md",
+    "**/*.mdx",
+    "**/*.tsx",
+    "**/*.ts",
+    "**/*.json"
+  ],
   "words": [
     "astro",
     "astrojs",
+    "Cupertino",
     "fontsource",
     "incentivized",
+    "laboratoria",
+    "mdlint",
     "multiplatform",
+    "pubspec",
     "tailwindcss",
     "todos",
     "tsconfigs"

package.json

@@ -9,6 +9,7 @@
     "preview": "astro preview",
     "astro": "astro",
     "type:check": "tsc",
+    "lint": "mdlint ./src/",
     "format": "prettier --write . --ext js,json,jsonc,ts,tsx,jsx,md,mdx",
     "format:check": "prettier --check ."
   },
@@ -30,6 +31,7 @@
     "typescript": "^5.4.5"
   },
   "devDependencies": {
+    "@laboratoria/mdlint": "^1.2.3",
     "eslint": "^9.3.0",
     "eslint-config-prettier": "^9.1.0",
     "eslint-plugin-astro": "^1.2.0",