[Astro] Re introduce link validation (#16806)

* Add link validation and some fixes

* another link fix

* Damn you links

* Only use in CI

* re-run install

* change input method

* Test another way

Author: kodster28

.github/workflows/ci.yml

@@ -42,6 +42,7 @@ jobs:
       - run: npm run build
         env:
           NODE_OPTIONS: "--max-old-space-size=4192"
+          RUN_LINK_CHECK: true
 
       - name: Check - Validate redirects (infinite loops, sources with fragment)
         run: npx tsm bin/validate-redirects.ts

astro.config.mjs

@@ -8,11 +8,14 @@ import rehypeSlug from "rehype-slug";
 import rehypeMermaid from "rehype-mermaid";
 import rehypeAutolinkHeadings from "rehype-autolink-headings";
 import rehypeExternalLinks from "rehype-external-links";
+import starlightLinksValidator from "starlight-links-validator";
 import { h } from "hastscript";
 import { readdir } from "fs/promises";
 import icon from "astro-icon";
 import sitemap from "@astrojs/sitemap";
 
+const runLinkCheck = process.env.RUN_LINK_CHECK || false;
+
 async function autogenSections() {
 	const sections = (
 		await readdir("./src/content/docs/", {
@@ -150,14 +153,42 @@ export default defineConfig({
 				"./src/table.css",
 				"./src/tailwind.css",
 			],
-			plugins: [
-				starlightDocSearch({
-					appId: "8MU1G3QO9P",
-					apiKey: "4edb0a6cef3338ff4bcfbc6b3d2db56b",
-					indexName: "TEST - Re-dev docs",
-				}),
-				starlightImageZoom(),
-			],
+			plugins: runLinkCheck
+				? [
+						starlightLinksValidator({
+							errorOnInvalidHashes: false,
+							exclude: [
+								"/api/",
+								"/api/operations/**",
+								"/changelog/",
+								"/http/resources/**",
+								"{props.*}",
+								"/",
+								"**/glossary/?term=**",
+								"/products/?product-group=*",
+								"/products/",
+								"/rules/snippets/examples/?operation=*",
+								"/rules/transform/examples/?operation=*",
+								"/workers/examples/?languages=*",
+								"/workers/examples/?tags=*",
+								"/workers-ai/models/**",
+							],
+						}),
+						starlightDocSearch({
+							appId: "8MU1G3QO9P",
+							apiKey: "4edb0a6cef3338ff4bcfbc6b3d2db56b",
+							indexName: "TEST - Re-dev docs",
+						}),
+						starlightImageZoom(),
+					]
+				: [
+						starlightDocSearch({
+							appId: "8MU1G3QO9P",
+							apiKey: "4edb0a6cef3338ff4bcfbc6b3d2db56b",
+							indexName: "TEST - Re-dev docs",
+						}),
+						starlightImageZoom(),
+					],
 		}),
 		tailwind({
 			applyBaseStyles: false,