feat: add linter CI for vocs-docs

.github/workflows/lint.yml

@@ -0,0 +1,29 @@
+name: Lint Vocs Docs
+
+on:
+  push:
+    paths:
+      - 'vocs-docs/**'
+  pull_request:
+    paths:
+      - 'vocs-docs/**'
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    defaults:
+      run:
+        working-directory: vocs-docs
+    steps:
+      - uses: actions/checkout@v4
+      - uses: pnpm/action-setup@v3
+        with:
+          version: 8
+      - uses: actions/setup-node@v4
+        with:
+          node-version: 20
+          cache: 'pnpm'
+      - name: Install dependencies
+        run: pnpm install
+      - name: Run linter
+        run: pnpm lint

vocs-docs/.remarkrc.js

@@ -0,0 +1,9 @@
+import remarkPresetLintRecommended from 'remark-preset-lint-recommended'
+import remarkLintNoShortcutReferenceLink from 'remark-lint-no-shortcut-reference-link'
+
+export default {
+  plugins: [
+    remarkPresetLintRecommended,
+    [remarkLintNoShortcutReferenceLink, false]
+  ]
+}

vocs-docs/package.json

@@ -6,7 +6,8 @@
   "scripts": {
     "dev": "vocs dev",
     "build": "vocs build",
-    "preview": "vocs preview"
+    "preview": "vocs preview",
+    "lint": "remark ./**/*.mdx --frail"
   },
   "dependencies": {
     "react": "latest",
@@ -15,6 +16,10 @@
   },
   "devDependencies": {
     "@types/react": "latest",
+    "remark": "^15.0.1",
+    "remark-cli": "^12.0.1",
+    "remark-lint-no-shortcut-reference-link": "^4.0.1",
+    "remark-preset-lint-recommended": "^7.0.1",
     "typescript": "latest"
   }
 }