feat: add json-ld schema to docs homepage (#739)

amaan-bhati · nehagup · web-flow · commit 86f340eb33a6 · 2025-12-31T15:55:11.000+05:30
Signed-off-by: amaan-bhati &lt;amaanbhati49@gmail.com&gt;
Co-authored-by: Neha Gupta &lt;gneha21@yahoo.in&gt;
diff --git a/src/pages/index.js b/src/pages/index.js
@@ -1,14 +1,81 @@
 import React from "react";
 import Layout from "@theme/Layout";
+import Head from "@docusaurus/Head";
 import useDocusaurusContext from "@docusaurus/useDocusaurusContext";
 import {Community, KeployCloud, Resources, QuickStart} from "../components";
 import {Products} from "../components/Product";
 //import {Intro} from "../components";
 export default function Home() {
   const context = useDocusaurusContext();
   const {siteConfig = {}} = context;
+  const toAbsoluteUrl = (baseUrl, url) => {
+    if (!url) {
+      return null;
+    }
+    if (url.startsWith("http://") || url.startsWith("https://")) {
+      return url;
+    }
+    const trimmedBase = baseUrl?.replace(/\/$/, "") ?? "";
+    const normalizedPath = url.startsWith("/") ? url : `/${url}`;
+    return `${trimmedBase}${normalizedPath}`;
+  };
+  const docsUrl = toAbsoluteUrl(siteConfig.url, siteConfig.baseUrl);
+  const breadcrumbSchema =
+    docsUrl && siteConfig.url
+      ? {
+          "@context": "https://schema.org",
+          "@type": "BreadcrumbList",
+          itemListElement: [
+            {
+              "@type": "ListItem",
+              position: 1,
+              name: "Home",
+              item: siteConfig.url,
+            },
+            {
+              "@type": "ListItem",
+              position: 2,
+              name: "Docs",
+              item: docsUrl,
+            },
+          ],
+        }
+      : null;
+  const articleSchema =
+    docsUrl && siteConfig.title
+      ? {
+          "@context": "https://schema.org",
+          "@type": "Article",
+          headline: siteConfig.title,
+          description: siteConfig.tagline,
+          mainEntityOfPage: {
+            "@type": "WebPage",
+            "@id": docsUrl,
+          },
+          publisher: {
+            "@type": "Organization",
+            name: "Keploy",
+            logo: {
+              "@type": "ImageObject",
+              url: "https://keploy.io/docs/img/favicon.png",
+            },
+          },
+        }
+      : null;
   return (
     <div className="main">
+      <Head>
+        {breadcrumbSchema && (
+          <script type="application/ld+json">
+            {JSON.stringify(breadcrumbSchema)}
+          </script>
+        )}
+        {articleSchema && (
+          <script type="application/ld+json">
+            {JSON.stringify(articleSchema)}
+          </script>
+        )}
+      </Head>
       <Layout
         className="mx-auto my-2 w-full max-w-screen-lg px-8 shadow-none"
         title={`${siteConfig.title}`}
