feat : add header linking (#1231)

Co-authored-by: dharamveergit <[email protected]> Co-authored-by: HoomanHq <[email protected]> Co-authored-by: Chaitanya Rai <[email protected]>
axelarnetwork · Oct 25, 2024 · e439984 · e439984
1 parent 2ca9cfc
commit e439984
Show file tree

Hide file tree

Showing 6 changed files with 429 additions and 375 deletions.
diff --git a/astro.config.mjs b/astro.config.mjs
@@ -5,8 +5,12 @@ import sitemap from "@astrojs/sitemap";
 import tailwind from "@astrojs/tailwind";
 import expressiveCode from "astro-expressive-code";
 import { defineConfig } from "astro/config";
+import { h } from "hastscript";
+import rehypeAutolinkHeadings from "rehype-autolink-headings";
+import rehypeSlug from "rehype-slug";
 import remarkDirective from "remark-directive";
-
+import remarkToc from "remark-toc";
+import { visit } from "unist-util-visit";
 // https://astro.build/config
 export default defineConfig({
   integrations: [
@@ -25,9 +29,62 @@ export default defineConfig({
       },
     }),
   ],
-  site: "https://axelardocs.vercel.app",
+  site: "https://docs.axelar.dev",
   trailingSlash: "always",
   markdown: {
-    remarkPlugins: [remarkDirective],
+    remarkPlugins: [
+      remarkDirective,
+      [
+        remarkToc,
+        {
+          heading: "contents",
+        },
+      ],
+    ],
+    rehypePlugins: [
+      rehypeSlug,
+      [
+        rehypeAutolinkHeadings,
+        {
+          behavior: "append",
+
+          content: [
+            h(
+              "span",
+              {
+                ariaHidden: "true",
+                class: "link",
+              },
+              h(
+                "svg",
+                {
+                  width: 16,
+                  height: 16,
+                  version: 1.1,
+                  viewBox: "0 0 16 16",
+                  xlmns: "http://www.w3.org/2000/svg",
+                },
+                h("path", {
+                  fillRule: "evenodd",
+                  fill: "currentcolor",
+                  d: "M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z",
+                }),
+              ),
+            ),
+          ],
+        },
+      ],
+      () => (tree) => {
+        visit(tree, "element", (node) => {
+          if (["h1", "h2", "h3", "h4", "h5", "h6"].includes(node.tagName)) {
+            node.properties = node.properties || {};
+            node.properties.className = [
+              ...(node.properties.className || []),
+              "header-links",
+            ];
+          }
+        });
+      },
+    ],
   },
 });
diff --git a/public/images/assets/amplifier_diagram-light.svg b/public/images/assets/amplifier_diagram-light.svg
diff --git a/public/images/assets/amplifier_diagram.svg b/public/images/assets/amplifier_diagram.svg
diff --git a/public/open-graph.webp b/public/open-graph.webp
diff --git a/src/layouts/MainLayout.astro b/src/layouts/MainLayout.astro
@@ -14,16 +14,22 @@ type Props = {
   className?: string;
 };
 
-const { title, description, image, hidden, notSidebar, className } =
-  Astro.props;
+const {
+  title,
+  description,
+  image = "/open-graph.webp",
+  hidden,
+  notSidebar,
+  className,
+} = Astro.props;
 
 const shownTitle = title
   ? title + ` | Axelar Documentation`
   : "Axelar Documentation";
 const shownDescription =
   description ||
   "The Axelar Documentation tells you how to get started and be successful using Axelar. Axelar allows developers to build interchain dApps that connect to any blockchain. ";
-const canonicalURL = new URL(Astro.url.pathname, "https://docs.axelar.dev");
+const canonicalURL = new URL(Astro.url.pathname, Astro.site);
 ---
 
 <!doctype html>
@@ -61,16 +67,21 @@ const canonicalURL = new URL(Astro.url.pathname, "https://docs.axelar.dev");
     <title>{shownTitle}</title>
     <meta content={shownTitle} property="og:title" />
     <meta content={shownTitle} property="twitter:title" />
-
+    <meta property="og:type" content="website" />
+    <meta property="og:url" content={Astro.url} />
+    <meta property="twitter:url" content={Astro.url} />
     <meta content={shownDescription} name="description" />
     <meta content={shownDescription} property="og:description" />
     <meta content={shownDescription} property="twitter:description" />
-    {image && <meta content={image} property="og:image" />}
-    {image && <meta content={image} property="twitter:image" />}
+    {image && <meta content={new URL(image, Astro.url)} property="og:image" />}
+    {
+      image && (
+        <meta content={new URL(image, Astro.url)} property="twitter:image" />
+      )
+    }
     <meta content="website" property="og:type" />
     <meta content="summary_large_image" name="twitter:card" />
     <meta content="width=device-width, initial-scale=1" name="viewport" />
-
     {hidden && <meta content="noindex" name="robots" />}
     <link
       rel="sitemap"

diff --git a/src/styles/global.css b/src/styles/global.css
@@ -2,6 +2,9 @@
 @tailwind components;
 @tailwind utilities;
 
+* {
+  scroll-margin-top: 95px;
+}
 @layer base {
   :root {
     --background: #fafafa;
@@ -122,3 +125,17 @@
     padding: 0 !important;
   }
 }
+
+.header-links {
+  cursor: pointer;
+}
+.header-links > a {
+  opacity: 0;
+  transition: opacity 0.3s ease-in-out;
+  display: inline-block;
+  margin-left: 0.5rem;
+}
+
+.header-links:hover > a {
+  opacity: 1;
+}