Merge pull request #319 from nikcio/feature/link-validator-to-docs

docs: Link validator for docs
nikcio · Jun 9, 2024 · 94637f3 · 94637f3
2 parents ce02300 + a31bb59
commit 94637f3
Show file tree

Hide file tree

Showing 5 changed files with 40 additions and 3 deletions.
diff --git a/docs/astro.config.mjs b/docs/astro.config.mjs
@@ -1,10 +1,11 @@
 import { defineConfig } from 'astro/config';
 import starlight from '@astrojs/starlight';
+import starlightLinksValidator from 'starlight-links-validator'
 
 // https://astro.build/config
 export default defineConfig({
   site: 'https://nikcio.github.io',
-  base: '/Nikcio.UHeadless',
+  base: '/Nikcio.UHeadless/',
   integrations: [
     starlight({
       title: 'Nikcio.UHeadless',
@@ -14,6 +15,9 @@ export default defineConfig({
       editLink: {
         baseUrl: 'https://github.com/nikcio/Nikcio.UHeadless/tree/'
       },
+      plugins: [starlightLinksValidator({
+          errorOnRelativeLinks: false,
+        })],
       sidebar: [
         {
           label: 'Welcome',

diff --git a/docs/package.json b/docs/package.json
@@ -12,6 +12,7 @@
   "dependencies": {
     "@astrojs/starlight": "^0.24.0",
     "astro": "^4.10.1",
-    "sharp": "^0.33.3"
+    "sharp": "^0.33.3",
+    "starlight-links-validator": "^0.9.0"
   }
 }
diff --git a/docs/pnpm-lock.yaml b/docs/pnpm-lock.yaml
diff --git a/docs/src/content/docs/v3/otherPackages/howToUseAExtendingPackage.md b/docs/src/content/docs/v3/otherPackages/howToUseAExtendingPackage.md
@@ -12,7 +12,7 @@ dotnet add NAME_OF_PACKAGE
 ## Register the queries, mutations or subscriptions
 If the extending package includes new queries you need to register these in the `startup.cs`. This can be done like this:
 
-```CSharp
+```csharp
 public void ConfigureServices(IServiceCollection services) {
 services.AddUmbraco(_env, _config)
     .AddBackOffice()

diff --git a/examples/code-examples/umbraco/Data/code-examples.sqlite b/examples/code-examples/umbraco/Data/code-examples.sqlite