Add link check Starlight plugin

Fryuni · Mar 9, 2024 · 4c2d618 · 4c2d618
1 parent 2774ee9
commit 4c2d618
Show file tree

Hide file tree

Showing 3 changed files with 47 additions and 35 deletions.
diff --git a/docs/astro.config.mjs b/docs/astro.config.mjs
@@ -1,5 +1,6 @@
 import { defineConfig } from 'astro/config';
 import starlight from '@astrojs/starlight';
+import starlightLinksValidator from 'starlight-links-validator';
 
 const SITE =
 	process.env.VERCEL_ENV !== 'production' && process.env.VERCEL_URL
@@ -37,15 +38,11 @@ export default defineConfig({
 					autogenerate: { directory: 'inline-mod' },
 				},
 			],
+			plugins: [
+				starlightLinksValidator({
+					errorOnRelativeLinks: true,
+				}),
+			],
 		}),
 	],
-	// markdown: {
-	// 	remarkPlugins: [
-	// 		() => (tree) => {
-	// 			visit(tree, 'code', (node) => {
-	// 				console.log(node);
-	// 			});
-	// 		},
-	// 	],
-	// }
 });
diff --git a/docs/package.json b/docs/package.json
@@ -15,7 +15,8 @@
     "@astrojs/starlight": "^0.21.1",
     "@vercel/analytics": "^1.2.2",
     "astro": "^4.4.15",
-    "sharp": "^0.33.2"
+    "sharp": "^0.33.2",
+    "starlight-links-validator": "^0.6.0"
   },
   "devDependencies": {
     "@astrojs/check": "^0.5.6",

diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml