Add structured WebSite data to index page if possible

Resolves #2760

Author: Gerrit0

CHANGELOG.md

@@ -1,5 +1,9 @@
 # Unreleased
 
+### Features
+
+-   If `hostedBaseUrl` is set to the root page on a website, TypeDoc will now include `WebSite` structured data, #2760.
+
 ### Bug Fixes
 
 -   Fix support for ESM config files with Node 23, #2752.

src/lib/output/themes/default/layouts/default.tsx

@@ -5,6 +5,34 @@ import type { PageEvent } from "../../../events";
 import { getDisplayName } from "../../lib";
 import type { DefaultThemeRenderContext } from "../DefaultThemeRenderContext";
 
+// See #2760
+function buildSiteMetadata(context: DefaultThemeRenderContext) {
+    try {
+        // We have to know where we are hosted in order to generate this block
+        const url = new URL(context.options.getValue("hostedBaseUrl"));
+
+        // No point in generating this if we aren't the root page on the site
+        if (url.pathname !== "/") {
+            return null;
+        }
+
+        return (
+            <script type="application/ld+json">
+                <Raw
+                    html={JSON.stringify({
+                        "@context": "https://schema.org",
+                        "@type": "WebSite",
+                        name: context.page.project.name,
+                        url: url.toString(),
+                    })}
+                />
+            </script>
+        );
+    } catch {
+        return null;
+    }
+}
+
 export const defaultLayout = (
     context: DefaultThemeRenderContext,
     template: RenderTemplate<PageEvent<Reflection>>,
@@ -20,6 +48,7 @@ export const defaultLayout = (
                     ? getDisplayName(props.model)
                     : `${getDisplayName(props.model)} | ${getDisplayName(props.project)}`}
             </title>
+            {props.url === "index.html" && buildSiteMetadata(context)}
             <meta name="description" content={"Documentation for " + props.project.name} />
             <meta name="viewport" content="width=device-width, initial-scale=1" />