chore(docs): fix base url paths

- Changed internal links in documentation to use root-relative paths for consistency.
- Added a new transform for site URLs to ensure correct linking in different environments.
- Updated various files to reflect these changes, including configuration and layout files.
- Added tests to verify that all internal links are correctly formatted.

Signed-off-by: Cory Rylan <crylan@nvidia.com>

Author: coryrylan

pnpm-lock.yaml

@@ -23,7 +23,6 @@ packages:
   - projects/cli
   - projects/code
   - projects/lint
-  - projects/snippets
   - projects/markdown
   - projects/media
   - projects/monaco

pnpm-workspace.yaml

@@ -145,13 +145,13 @@ export const Links = {
   render: () => html`
 <nve-tabs>
   <nve-tabs-item selected>
-    <a href="./docs/elements/tabs/#links">Tab 1</a>
+    <a href="#links">Tab 1</a>
   </nve-tabs-item>
   <nve-tabs-item>
-    <a href="./docs/elements/tabs/#links">Tab 2</a>
+    <a href="#links">Tab 2</a>
   </nve-tabs-item>
   <nve-tabs-item>
-    <a href="/docs/elements/tabs/#links">Tab 3</a>
+    <a href="#links">Tab 3</a>
   </nve-tabs-item>
 </nve-tabs>`
 };

projects/core/src/tabs/tabs.examples.ts

@@ -1,6 +1,6 @@
 // @ts-check
 
-import { EleventyRenderPlugin, IdAttributePlugin } from '@11ty/eleventy';
+import { EleventyRenderPlugin, HtmlBasePlugin, IdAttributePlugin } from '@11ty/eleventy';
 import EleventyPluginVite from '@11ty/eleventy-plugin-vite';
 import litPlugin from '@lit-labs/eleventy-plugin-lit';
 
@@ -19,6 +19,7 @@ import { llmsTxtPlugin } from './src/_11ty/plugins/llms-txt.js';
 import { sitemapPlugin } from './src/_11ty/plugins/sitemap-xml.js';
 import { elementLoaderTransform } from './src/_11ty/transforms/element-loader.js';
 import { anchorGeneratorTransform } from './src/_11ty/transforms/anchor-generator.js';
+import { siteUrlsTransform } from './src/_11ty/transforms/site-urls.js';
 import { htmlMinifyTransform } from './src/_11ty/transforms/html-minify.js';
 import { envReplaceTransform } from './src/_11ty/transforms/env-replace.js';
 import {
@@ -42,6 +43,7 @@ import { svgLogoShortcode, svgLogosShortcode } from './src/_11ty/shortcodes/svg-
 import { tokensShortcode } from './src/_11ty/shortcodes/tokens.js';
 import markdown from './src/_11ty/libraries/markdown.js';
 import { ApiService } from '@internals/metadata';
+import { ELEMENTS_SITE_ORIGIN } from './src/_11ty/utils/site-url.js';
 
 const apis = await ApiService.getData();
 
@@ -88,6 +90,8 @@ const entrypoints = [
  * Sets up plugins, transforms, collections, and build options
  */
 export default function (eleventyConfig) {
+  eleventyConfig.pathPrefix = BASE_URL;
+
   // Add core 11ty plugins
   eleventyConfig.addPlugin(EleventyRenderPlugin);
   eleventyConfig.addPlugin(IdAttributePlugin, { checkDuplicates: false });
@@ -154,18 +158,6 @@ export default function (eleventyConfig) {
     }
   });
 
-  // Configure server options for development
-  eleventyConfig.setServerOptions({
-    onRequest: {
-      '/': () => ({
-        status: 307,
-        headers: {
-          Location: BASE_URL
-        }
-      })
-    }
-  });
-
   // Add search plugin for documentation search functionality
   if (process.env.ELEVENTY_RUN_MODE === 'build') {
     eleventyConfig.addPlugin(searchPlugin, {
@@ -209,6 +201,10 @@ export default function (eleventyConfig) {
   eleventyConfig.addTransform('env-replace', envReplaceTransform);
   eleventyConfig.addTransform('element-loader', elementLoaderTransform);
   eleventyConfig.addTransform('anchor-generator', anchorGeneratorTransform);
+  eleventyConfig.addPlugin(HtmlBasePlugin, {
+    baseHref: process.env.ELEVENTY_RUN_MODE === 'build' ? ELEMENTS_SITE_ORIGIN : '/'
+  });
+  eleventyConfig.addTransform('site-urls', siteUrlsTransform);
 
   if (process.env.ELEVENTY_RUN_MODE === 'build') {
     eleventyConfig.addTransform('html-minify', htmlMinifyTransform);
@@ -228,14 +224,16 @@ export default function (eleventyConfig) {
    */
   eleventyConfig.addCollection('componentDocs', function (collection) {
     // https://github.com/11ty/eleventy/issues/3838 each rebuild of any md file triggers all rebuilds of collection
-    return collection.getFilteredByGlob([
-      'src/docs/elements/*.md',
-      'src/docs/elements/data-grid/index.md',
-      'src/docs/code/*.md',
-      'src/docs/monaco/*.md',
-      'src/docs/media/*.md',
-      'src/docs/markdown/index.md'
-    ]);
+    return collection
+      .getFilteredByGlob([
+        'src/docs/elements/*.md',
+        'src/docs/elements/data-grid/index.md',
+        'src/docs/code/*.md',
+        'src/docs/monaco/*.md',
+        'src/docs/media/*.md',
+        'src/docs/markdown/index.md'
+      ])
+      .filter(page => page.data.tag);
   });
 
   // prevent rebuild of api, examples tabs, and example pages on each run
@@ -263,6 +261,7 @@ export default function (eleventyConfig) {
       input: 'src',
       output: 'dist',
       layouts: '_11ty/layouts'
-    }
+    },
+    pathPrefix: BASE_URL
   };
 }

projects/site/eleventy.config.js

@@ -70,6 +70,10 @@
         "ELEMENTS_SITE_URL": {
           "external": true,
           "default": "https://nvidia.github.io"
+        },
+        "LOCAL_PREVIEW": {
+          "external": true,
+          "default": "false"
         }
       }
     },
@@ -197,17 +201,17 @@
       ]
     },
     "test": {
-      "command": "vitest run src/_11ty/layouts/metadata.test.ts src/_11ty/shortcodes/api.test.ts",
+      "command": "vitest run src/_11ty/layouts/metadata.test.ts src/_11ty/layouts/links.test.ts src/_11ty/transforms/site-urls.test.ts src/_11ty/shortcodes/api.test.ts src/_11ty/plugins/llms-txt.test.ts src/_11ty/plugins/sitemap-xml.test.ts",
       "files": [
-        "src/docs/**/*.md",
-        "src/_11ty/layouts/common.js",
-        "src/_11ty/layouts/metadata.js",
-        "src/_11ty/layouts/metadata.test.ts",
-        "src/_11ty/shortcodes/api.js",
-        "src/_11ty/shortcodes/api.test.ts",
+        "src/**/*.js",
+        "src/**/*.md",
+        "src/**/*.ts",
         "vitest.config.ts"
       ],
-      "output": []
+      "output": [],
+      "dependencies": [
+        "build"
+      ]
     },
     "test:lighthouse": {
       "command": "playwright-lock 'vitest run --config=vitest.lighthouse.ts'",
@@ -233,42 +237,43 @@
     }
   },
   "dependencies": {
+    "3d-force-graph": "1.79.0",
     "chart.js": "4.5.1",
-    "lit": "catalog:",
-    "3d-force-graph": "1.79.0"
+    "lit": "catalog:"
   },
   "devDependencies": {
     "@11ty/eleventy": "catalog:",
     "@11ty/eleventy-plugin-vite": "catalog:",
     "@eslint/js": "catalog:",
-    "@lit-labs/eleventy-plugin-lit": "catalog:",
-    "@lit-labs/ssr-client": "catalog:",
     "@internals/eslint": "workspace:*",
     "@internals/metadata": "workspace:*",
-    "@internals/tools": "workspace:*",
     "@internals/patterns": "workspace:*",
+    "@internals/tools": "workspace:*",
     "@internals/vite": "workspace:*",
+    "@lit-labs/eleventy-plugin-lit": "catalog:",
+    "@lit-labs/ssr-client": "catalog:",
     "@nvidia-elements/code": "workspace:*",
+    "@nvidia-elements/core": "workspace:*",
     "@nvidia-elements/forms": "workspace:*",
     "@nvidia-elements/lint": "workspace:*",
     "@nvidia-elements/markdown": "workspace:*",
     "@nvidia-elements/media": "workspace:*",
-    "@nvidia-elements/core": "workspace:*",
     "@nvidia-elements/monaco": "workspace:*",
     "@nvidia-elements/styles": "workspace:*",
     "@nvidia-elements/themes": "workspace:*",
     "@vitest/coverage-istanbul": "catalog:",
     "compare-versions": "6.1.1",
     "eslint": "catalog:",
-    "stylelint": "catalog:",
-    "stylelint-config-standard": "catalog:",
     "html-minifier-next": "5.2.2",
     "lighthouse": "catalog:",
     "lightningcss": "1.30.2",
     "markdown-it": "catalog:",
     "markdown-it-link-attributes": "catalog:",
     "pagefind": "1.3.0",
+    "parse5": "7.1.2",
     "playwright": "catalog:",
+    "stylelint": "catalog:",
+    "stylelint-config-standard": "catalog:",
     "typescript": "catalog:",
     "vite": "catalog:",
     "vitest": "catalog:"