From 377085c132b105a120c649fc6b09810ba0453b36 Mon Sep 17 00:00:00 2001 From: Somraj Saha <31373860+Jarmos-san@users.noreply.github.com> Date: Thu, 3 Oct 2024 19:16:02 +0530 Subject: [PATCH] chore: add and configure a Starlight plugin --- docs/astro.config.mjs | 5 ++-- docs/package.json | 1 + docs/pnpm-lock.yaml | 53 +++++++++++++++++++++++++++++++++++++++++++ 3 files changed, 57 insertions(+), 2 deletions(-) diff --git a/docs/astro.config.mjs b/docs/astro.config.mjs index ce6859b..cd67c2a 100644 --- 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 starlightLinksValidatorPlugin from "starlight-links-validator"; export default defineConfig({ site: "https://weburz.github.io/repoforge", @@ -7,8 +8,7 @@ export default defineConfig({ integrations: [ starlight({ title: "RepoForge", - description: - "Scaffold your projects with ease and efficiency through the power of automation!", + description: "Scaffold your projects through the power of automation!", editLink: { baseUrl: "https://github.com/Weburz/repoforge/edit/main/docs", }, @@ -38,6 +38,7 @@ export default defineConfig({ autogenerate: { directory: "reference" }, }, ], + plugins: [starlightLinksValidatorPlugin()], }), ], }); diff --git a/docs/package.json b/docs/package.json index ba16d6d..9f53c5e 100644 --- a/docs/package.json +++ b/docs/package.json @@ -16,6 +16,7 @@ "astro": "^4.15.10", "prettier": "^3.3.3", "sharp": "^0.33.5", + "starlight-links-validator": "^0.12.2", "typescript": "^5.6.2" }, "prettier": { diff --git a/docs/pnpm-lock.yaml b/docs/pnpm-lock.yaml index bdea6f0..c68c25b 100644 --- a/docs/pnpm-lock.yaml +++ b/docs/pnpm-lock.yaml @@ -23,6 +23,9 @@ importers: sharp: specifier: ^0.33.5 version: 0.33.5 + starlight-links-validator: + specifier: ^0.12.2 + version: 0.12.2(@astrojs/starlight@0.28.2(astro@4.15.10(rollup@4.21.1)(typescript@5.6.2)))(astro@4.15.10(rollup@4.21.1)(typescript@5.6.2)) typescript: specifier: ^5.6.2 version: 5.6.2 @@ -676,6 +679,9 @@ packages: '@types/node@17.0.45': resolution: {integrity: sha512-w+tIMs3rq2afQdsPJlODhoUEKzFP1ayaoyl1CcnwtIlsVe7K7bA1NGm4s3PraqTLlXnbIN84zuBlxBWo1u9BLw==} + '@types/picomatch@2.3.3': + resolution: {integrity: sha512-Yll76ZHikRFCyz/pffKGjrCwe/le2CDwOP5F210KQo27kpRE46U2rDnzikNlVn6/ezH3Mhn46bJMTfeVTtcYMg==} + '@types/sax@1.2.7': resolution: {integrity: sha512-rO73L89PJxeYM3s3pPPjiPgVVcymqU490g0YO5n5By0k2Erzj6tay/4lr1CHAAU4JyOWd1rpQ8bCf6cZfHU96A==} @@ -1116,6 +1122,9 @@ packages: hast-util-embedded@3.0.0: resolution: {integrity: sha512-naH8sld4Pe2ep03qqULEtvYr7EjrLK2QHY8KJR6RJkTUjPGObe1vnx585uzem2hGra+s1q08DZZpfgDVYRbaXA==} + hast-util-from-html@2.0.1: + resolution: {integrity: sha512-RXQBLMl9kjKVNkJTIO6bZyb2n+cUH8LFaSSzo82jiLT6Tfc+Pt7VQCS+/h3YwG4jaNE2TA2sdJisGWR+aJrp0g==} + hast-util-from-html@2.0.2: resolution: {integrity: sha512-HwOHwxdt2zC5KQ/CNoybBntRook2zJvfZE/u5/Ap7aLPe22bDqen7KwGkOqOyzL5zIqKwiYX/OTtE0FWgr6XXA==} @@ -1197,6 +1206,10 @@ packages: inline-style-parser@0.2.3: resolution: {integrity: sha512-qlD8YNDqyTKTyuITrDOffsl6Tdhv+UC4hcdAVuQsK4IMQ99nSgd1MIA/Q+jQYoh9r3hVUXhYh7urSRmXPkW04g==} + is-absolute-url@4.0.1: + resolution: {integrity: sha512-/51/TKE88Lmm7Gc4/8btclNXWS+g50wXhYJq8HWIBAGUBnoAdRu1aXeh364t/O7wXDAcTJDP8PNuNKWUDWie+A==} + engines: {node: ^12.20.0 || ^14.13.1 || >=16.0.0} + is-alphabetical@2.0.1: resolution: {integrity: sha512-FWyyY60MeTNyeSRpkM2Iry0G9hpr7/9kD40mD/cGQEuilcZYS4okz8SN2Q6rLCJ8gbCt6fN+rC+6tMGS99LaxQ==} @@ -1619,6 +1632,10 @@ packages: resolution: {integrity: sha512-JU3teHTNjmE2VCGFzuY8EXzCDVwEqB2a8fsIvwaStHhAWJEeVd1o1QD80CU6+ZdEXXSLbSsuLwJjkCBWqRQUVA==} engines: {node: '>=8.6'} + picomatch@4.0.2: + resolution: {integrity: sha512-M7BAV6Rlcy5u+m6oPhAPFgJTzAioX/6B0DxyvDlo9l8+T3nLKbrczg2WLUyzd45L8RqfUMyGPzekbMvX2Ldkwg==} + engines: {node: '>=12'} + pify@4.0.1: resolution: {integrity: sha512-uB80kBFb/tfd68bVleG9T5GGsGPjJrLAUpR5PZIrhBnIaRTQRjqdJSsIKkOP6OAIFbj7GOrcudc5pNjZ+geV2g==} engines: {node: '>=6'} @@ -1819,6 +1836,13 @@ packages: sprintf-js@1.0.3: resolution: {integrity: sha512-D9cPgkvLlV3t3IzL0D0YLvGA9Ahk4PcvVwUbN0dSGr1aP0Nrt4AEnTUbuGvquEC0mA64Gqt1fzirlRs5ibXx8g==} + starlight-links-validator@0.12.2: + resolution: {integrity: sha512-Iw1AvIULw7Tx4sGmPQciWD8jD2SIG14ynywqUyQYtxiao+phH7KWCwlm5TZ5PchrUm9nNSBYriufYwsd+VDQ3w==} + engines: {node: '>=18.14.1'} + peerDependencies: + '@astrojs/starlight': '>=0.15.0' + astro: '>=4.0.0' + stdin-discarder@0.2.2: resolution: {integrity: sha512-UhDfHmA92YAlNnCfhmq0VeNL5bDbiZGg7sZ2IvPsXubGkiNa9EC+tUTsjBRsYUAz87btI6/1wf4XoVvQ3uRnmQ==} engines: {node: '>=18'} @@ -2879,6 +2903,8 @@ snapshots: '@types/node@17.0.45': {} + '@types/picomatch@2.3.3': {} + '@types/sax@1.2.7': dependencies: '@types/node': 17.0.45 @@ -3395,6 +3421,15 @@ snapshots: '@types/hast': 3.0.4 hast-util-is-element: 3.0.0 + hast-util-from-html@2.0.1: + dependencies: + '@types/hast': 3.0.4 + devlop: 1.1.0 + hast-util-from-parse5: 8.0.1 + parse5: 7.1.2 + vfile: 6.0.3 + vfile-message: 4.0.2 + hast-util-from-html@2.0.2: dependencies: '@types/hast': 3.0.4 @@ -3602,6 +3637,8 @@ snapshots: inline-style-parser@0.2.3: {} + is-absolute-url@4.0.1: {} + is-alphabetical@2.0.1: {} is-alphanumerical@2.0.1: @@ -4293,6 +4330,8 @@ snapshots: picomatch@2.3.1: {} + picomatch@4.0.2: {} + pify@4.0.1: {} pkg-dir@4.2.0: @@ -4592,6 +4631,20 @@ snapshots: sprintf-js@1.0.3: {} + starlight-links-validator@0.12.2(@astrojs/starlight@0.28.2(astro@4.15.10(rollup@4.21.1)(typescript@5.6.2)))(astro@4.15.10(rollup@4.21.1)(typescript@5.6.2)): + dependencies: + '@astrojs/starlight': 0.28.2(astro@4.15.10(rollup@4.21.1)(typescript@5.6.2)) + '@types/picomatch': 2.3.3 + astro: 4.15.10(rollup@4.21.1)(typescript@5.6.2) + github-slugger: 2.0.0 + hast-util-from-html: 2.0.1 + hast-util-has-property: 3.0.0 + is-absolute-url: 4.0.1 + kleur: 4.1.5 + mdast-util-to-string: 4.0.0 + picomatch: 4.0.2 + unist-util-visit: 5.0.0 + stdin-discarder@0.2.2: {} stream-replace-string@2.0.0: {}