Merge pull request #189 from charlesLoder/fix-base-path

Update documentation site
charlesLoder · Dec 19, 2024 · 6dfd5e1 · 6dfd5e1
2 parents e8c178f + ee1eeb5
commit 6dfd5e1
Show file tree

Hide file tree

Showing 3 changed files with 87 additions and 5 deletions.
diff --git a/docs/astro.config.mjs b/docs/astro.config.mjs
@@ -1,6 +1,9 @@
 import starlight from "@astrojs/starlight";
 import { defineConfig } from "astro/config";
 import starlightTypeDoc, { typeDocSidebarGroup } from "starlight-typedoc";
+import { remarkBasePath } from "./prepend_base_path.js";
+
+const basePath = process.env.NODE_ENV === "production" ? "/havarotjs" : "";
 
 // https://astro.build/config
 export default defineConfig({
@@ -10,7 +13,10 @@ export default defineConfig({
   build: {
     assets: "assets"
   },
-  base: process.env.NODE_ENV === "production" ? "havarotjs" : "",
+  base: basePath,
+  markdown: {
+    remarkPlugins: [[remarkBasePath, { base: basePath }]]
+  },
   integrations: [
     starlight({
       title: `havarotjs v${process.env.npm_package_version || ""}`,
@@ -30,11 +36,11 @@ export default defineConfig({
       sidebar: [
         {
           label: "Getting started",
-          link: "/"
+          link: `/`
         },
         {
           label: "Changelog",
-          link: "/changelog"
+          link: `/changelog`
         },
         // Add the generated sidebar group to the sidebar.
         typeDocSidebarGroup,

diff --git a/docs/prepend_base_path.js b/docs/prepend_base_path.js
@@ -0,0 +1,76 @@
+// @ts-check
+import { CONTINUE, visit } from "unist-util-visit";
+
+/**
+ * Check if url is absolute
+ *
+ * @param {string} url
+ * @returns {boolean}
+ */
+function isAbsoluteUrl(url) {
+  return url.startsWith("http://") || url.startsWith("https://");
+}
+
+/**
+ * Check if url is a heading link
+ *
+ * @param {string} url
+ */
+function isHeadingLink(url) {
+  return url.startsWith("#");
+}
+
+/**
+ * Check if node is a link node
+ *
+ */
+function isLinkNode(node) {
+  return node.type === "link" && !!node.url;
+}
+
+/**
+ * Check if url starts with base path
+ *
+ * @param {string} str
+ * @param {string} base
+ */
+function startsWithBasePath(str, base) {
+  return str.startsWith(base);
+}
+
+export function remarkBasePath(options = {}) {
+  const { base = "" } = options;
+
+  return (tree) => {
+    visit(tree, (node) => {
+      // Handle link nodes
+      if (isLinkNode(node)) {
+        if (!isAbsoluteUrl(node.url) && !isHeadingLink(node.url) && !startsWithBasePath(node.url, base)) {
+          node.url = `${base}${node.url}`;
+        }
+        return CONTINUE;
+      }
+
+      const hasAttrs = !!node.attributes && Array.isArray(node.attributes);
+      if (!hasAttrs) {
+        return;
+      }
+      const hasHref = node?.attributes?.find((a) => a.name === "href");
+
+      if (hasHref) {
+        node.attributes = node.attributes.map((a) => {
+          if (
+            a.name === "href" &&
+            !isAbsoluteUrl(a.value) &&
+            !isHeadingLink(a.value) &&
+            !startsWithBasePath(a.value, base)
+          ) {
+            a.value = `${base}${a.value}`;
+            return a;
+          }
+          return a;
+        });
+      }
+    });
+  };
+}
diff --git a/docs/src/content/docs/index.mdx b/docs/src/content/docs/index.mdx
@@ -3,7 +3,7 @@ title: Getting Started
 next: false
 ---
 
-import { Code, TabItem, Tabs } from "@astrojs/starlight/components";
+import { Code, TabItem, Tabs, LinkCard } from "@astrojs/starlight/components";
 
 Syllabify Hebrew text
 
@@ -56,4 +56,4 @@ Syllabify Hebrew text
 
 ## Learn more
 
-To learn more, see the [`Text`](/api/classes/text) class
+<LinkCard title="Text" href="/api/classes/text/" description="To learn more see the <code>Text</code> class" />