@farming-labs/theme 0.1.84 → 0.1.86

package/dist/docs-api.mjs

@@ -3,7 +3,7 @@ import { getNextAppDir } from "./get-app-dir.mjs";
 import fs from "node:fs";
 import path from "node:path";
 import matter from "gray-matter";
-import { buildDocsAskAIContext, createDocsAgentTraceContext, createDocsAgentTraceId, createDocsSitemapResponse, emitDocsAgentTraceEvent, emitDocsAnalyticsEvent, formatDocsAskAIPackageHints, getDocsMarkdownVaryHeader, hasDocsMarkdownSignatureAgent, normalizeDocsRelated, performDocsSearch, renderDocsMarkdownNotFound, renderDocsRelatedMarkdownLines, resolveAskAISearchRequestConfig, resolveChangelogConfig, resolveDocsI18n, resolveDocsLocale, resolveDocsSitemapConfig, resolvePageSidebarFolderIndexBehavior, resolveSearchRequestConfig } from "@farming-labs/docs";
+import { buildDocsAskAIContext, createDocsAgentTraceContext, createDocsAgentTraceId, createDocsSitemapResponse, emitDocsAgentTraceEvent, emitDocsAnalyticsEvent, formatDocsAskAIPackageHints, getDocsMarkdownVaryHeader, hasDocsMarkdownSignatureAgent, normalizeDocsRelated, performDocsSearch, renderDocsMarkdownNotFound, renderDocsRelatedMarkdownLines, resolveAskAISearchRequestConfig, resolveChangelogConfig, resolveDocsI18n, resolveDocsLocale, resolveDocsSitemapConfig, resolvePageSidebarFolderIndexBehavior, resolveSearchRequestConfig, toDocsMarkdownUrl } from "@farming-labs/docs";
 import { createDocsMcpHttpHandler, createFilesystemDocsMcpSource, readDocsSitemapManifest, resolveDocsMcpConfig } from "@farming-labs/docs/server";
 
 //#region src/docs-api.ts
@@ -211,6 +211,7 @@ function buildAgentSpec({ origin, entry, i18n, search, mcp, feedback, llms, site
 			search: searchEnabled,
 			sitemap: sitemapConfig.enabled,
 			robots: robotsEnabled,
+			structuredData: true,
 			agentFeedback: feedback.enabled,
 			locales: localesEnabled
 		},
@@ -265,6 +266,20 @@ function buildAgentSpec({ origin, entry, i18n, search, mcp, feedback, llms, site
 			route: DEFAULT_ROBOTS_TXT_ROUTE,
 			defaultRoute: DEFAULT_ROBOTS_TXT_ROUTE
 		},
+		structuredData: {
+			enabled: true,
+			format: "application/ld+json",
+			schema: "https://schema.org/TechArticle",
+			fields: [
+				"headline",
+				"description",
+				"url",
+				"dateModified",
+				"breadcrumb"
+			],
+			canonicalUrlField: "url",
+			breadcrumbType: "BreadcrumbList"
+		},
 		search: {
 			enabled: searchEnabled,
 			endpoint: `${DEFAULT_DOCS_API_ROUTE}?query={query}`,
@@ -1554,7 +1569,7 @@ function generateLlmsTxt(indexes, options) {
 	if (siteDescription) llmsTxt += `> ${siteDescription}\n\n`;
 	llmsTxt += `## Pages\n\n`;
 	for (const page of indexes) {
-		llmsTxt += `- [${page.title}](${baseUrl}${page.url})`;
+		llmsTxt += `- [${page.title}](${baseUrl}${toDocsMarkdownUrl(page.url)})`;
 		if (page.description) llmsTxt += `: ${page.description}`;
 		llmsTxt += `\n`;
 	}

package/dist/docs-layout.mjs

@@ -11,7 +11,7 @@ import path from "node:path";
 import matter from "gray-matter";
 import { DocsLayout } from "fumadocs-ui/layouts/docs";
 import { Suspense } from "react";
-import { applySidebarFolderIndexBehavior, buildPageOpenGraph, buildPageTwitter, resolveChangelogConfig, resolveDocsAgentMdxContent, resolveDocsAnalyticsConfig, resolvePageSidebarFolderIndexBehavior, toDocsMarkdownUrl } from "@farming-labs/docs";
+import { applySidebarFolderIndexBehavior, buildPageOpenGraph, buildPageTwitter, renderDocsPageStructuredDataJson, resolveChangelogConfig, resolveDocsAgentMdxContent, resolveDocsAnalyticsConfig, resolveDocsMetadataBaseUrl, resolvePageSidebarFolderIndexBehavior, toDocsMarkdownUrl } from "@farming-labs/docs";
 import { jsx, jsxs } from "react/jsx-runtime";
 
 //#region src/docs-layout.tsx
@@ -380,6 +380,41 @@ function buildReadingTimeMap(config, ctx, options) {
 	scan(docsDir, []);
 	return map;
 }
+function findDocsPageFile(dir) {
+	return ["page.mdx", "page.md"].map((fileName) => path.join(dir, fileName)).find(fs.existsSync);
+}
+function buildStructuredDataMap(config, ctx) {
+	const docsDir = ctx.docsDir;
+	const map = {};
+	const excludedDirs = getExcludedDocsDirs(config, ctx);
+	const baseUrl = resolveDocsMetadataBaseUrl(config);
+	function scan(dir, slugParts) {
+		if (!fs.existsSync(dir)) return;
+		if (isExcludedDir(dir, excludedDirs)) return;
+		const pagePath = findDocsPageFile(dir);
+		if (pagePath) {
+			const { data } = matter(fs.readFileSync(pagePath, "utf-8"));
+			const route = slugParts.length === 0 ? `/${ctx.entryPath}` : `/${ctx.entryPath}/${slugParts.join("/")}`;
+			const title = typeof data.title === "string" ? data.title : slugParts.at(-1)?.replace(/-/g, " ") || "Documentation";
+			const description = typeof data.description === "string" ? data.description : void 0;
+			const stat = fs.statSync(pagePath);
+			map[route] = renderDocsPageStructuredDataJson({
+				title,
+				description,
+				url: withLangInUrl(route, ctx.locale),
+				baseUrl,
+				entry: ctx.entryPath,
+				dateModified: stat.mtime.toISOString()
+			});
+		}
+		for (const name of fs.readdirSync(dir)) {
+			const full = path.join(dir, name);
+			if (fs.statSync(full).isDirectory()) scan(full, [...slugParts, name]);
+		}
+	}
+	scan(docsDir, []);
+	return map;
+}
 /**
 * Build a Next.js Metadata object from the docs config.
 *
@@ -638,6 +673,7 @@ function createDocsLayout(config, options) {
 		enabledByDefault: readingTimeEnabledByDefault,
 		wordsPerMinute: readingTimeWordsPerMinute
 	});
+	const structuredDataMap = buildStructuredDataMap(config, localeContext);
 	const readingTimeEnabled = readingTimeEnabledByDefault || Object.keys(readingTimeMap).length > 0;
 	return function DocsLayoutWrapper({ children }) {
 		const tree = applySidebarFolderIndexBehavior(buildTree(config, localeContext, !!sidebarFlat), {
@@ -736,6 +772,7 @@ function createDocsLayout(config, options) {
 						lastUpdatedPosition,
 						readingTimeEnabled,
 						readingTimeMap,
+						structuredDataMap,
 						llmsTxtEnabled,
 						descriptionMap,
 						feedbackEnabled: feedbackConfig.enabled,

package/dist/docs-page-client.d.mts

@@ -43,6 +43,10 @@ interface DocsPageClientProps {
   readingTimeMap?: Record<string, number>;
   /** Direct reading-time override for the current page. */
   readingTime?: number | null;
+  /** Map of pathname → serialized Schema.org JSON-LD. */
+  structuredDataMap?: Record<string, string>;
+  /** Direct serialized Schema.org JSON-LD override for the current page. */
+  structuredData?: string;
   /**
    * Whether path-based reading time values should render by default.
    * Explicit `readingTime` overrides can still render when this is false.
@@ -90,6 +94,8 @@ declare function DocsPageClient({
   lastModified: lastModifiedProp,
   readingTimeMap,
   readingTime: readingTimeProp,
+  structuredDataMap,
+  structuredData: structuredDataProp,
   readingTimeEnabled,
   lastUpdatedEnabled,
   lastUpdatedPosition,

package/dist/docs-page-client.mjs

@@ -5,6 +5,7 @@ import { PageActions } from "./page-actions.mjs";
 import { useWindowSearchParams } from "./client-location.mjs";
 import { DocsFeedback } from "./docs-feedback.mjs";
 import { resolveClientLocale, withLangInUrl } from "./i18n.mjs";
+import { escapeJsonLdForScript } from "./json-ld.mjs";
 import { Children, Fragment, cloneElement, isValidElement, useEffect, useState } from "react";
 import { DocsBody, DocsPage, EditOnGitHub } from "fumadocs-ui/layouts/docs/page";
 import { createPortal } from "react-dom";
@@ -163,7 +164,7 @@ function TitleDecorations({ description, belowTitle }) {
 	if (!description && !belowTitle) return null;
 	return /* @__PURE__ */ jsx(Fragment$1, { children: Children.toArray([description, belowTitle].filter(Boolean)) });
 }
-function DocsPageClient({ tocEnabled, tocStyle = "default", breadcrumbEnabled = true, changelogBasePath, entry = "docs", locale, copyMarkdown = false, openDocs = false, openDocsProviders, pageActionsPosition = "below-title", pageActionsAlignment = "left", githubUrl, contentDir, githubBranch = "main", githubDirectory, editOnGithubUrl, lastModifiedMap, lastModified: lastModifiedProp, readingTimeMap, readingTime: readingTimeProp, readingTimeEnabled = false, lastUpdatedEnabled = true, lastUpdatedPosition = "footer", llmsTxtEnabled = false, descriptionMap, description, feedbackEnabled = false, feedbackQuestion, feedbackPlaceholder, feedbackPositiveLabel, feedbackNegativeLabel, feedbackSubmitLabel, feedbackOnFeedback, analytics = false, children }) {
+function DocsPageClient({ tocEnabled, tocStyle = "default", breadcrumbEnabled = true, changelogBasePath, entry = "docs", locale, copyMarkdown = false, openDocs = false, openDocsProviders, pageActionsPosition = "below-title", pageActionsAlignment = "left", githubUrl, contentDir, githubBranch = "main", githubDirectory, editOnGithubUrl, lastModifiedMap, lastModified: lastModifiedProp, readingTimeMap, readingTime: readingTimeProp, structuredDataMap, structuredData: structuredDataProp, readingTimeEnabled = false, lastUpdatedEnabled = true, lastUpdatedPosition = "footer", llmsTxtEnabled = false, descriptionMap, description, feedbackEnabled = false, feedbackQuestion, feedbackPlaceholder, feedbackPositiveLabel, feedbackNegativeLabel, feedbackSubmitLabel, feedbackOnFeedback, analytics = false, children }) {
 	const fdTocStyle = tocStyle === "directional" ? "clerk" : void 0;
 	const [toc, setToc] = useState([]);
 	const [titlePortalHost, setTitlePortalHost] = useState(null);
@@ -175,6 +176,7 @@ function DocsPageClient({ tocEnabled, tocStyle = "default", breadcrumbEnabled =
 	const normalizedPath = (browserPath ?? pathname).replace(/\/$/, "") || "/";
 	const isChangelogRoute = !!(changelogBasePath && (normalizedPath === changelogBasePath || normalizedPath.startsWith(`${changelogBasePath}/`)));
 	const matchedReadingTime = readingTimeMap?.[normalizedPath];
+	const structuredDataJson = !isChangelogRoute ? structuredDataProp ?? structuredDataMap?.[normalizedPath] : void 0;
 	useEffect(() => {
 		if (!analytics) return;
 		emitClientAnalyticsEvent({
@@ -341,7 +343,10 @@ function DocsPageClient({ tocEnabled, tocStyle = "default", breadcrumbEnabled =
 		belowTitle: belowTitleBlock
 	}), titlePortalHost) : null;
 	const renderedChildren = Children.toArray(decoratedChildren);
-	return /* @__PURE__ */ jsxs(DocsPage, {
+	return /* @__PURE__ */ jsxs(Fragment$1, { children: [structuredDataJson && /* @__PURE__ */ jsx("script", {
+		type: "application/ld+json",
+		dangerouslySetInnerHTML: { __html: escapeJsonLdForScript(structuredDataJson) }
+	}), /* @__PURE__ */ jsxs(DocsPage, {
 		full: false,
 		toc,
 		tableOfContent: {
@@ -428,7 +433,7 @@ function DocsPageClient({ tocEnabled, tocStyle = "default", breadcrumbEnabled =
 				]
 			})
 		]
-	});
+	})] });
 }
 
 //#endregion

package/dist/json-ld.mjs

@@ -0,0 +1,7 @@
+//#region src/json-ld.ts
+function escapeJsonLdForScript(json) {
+	return json.replace(/</g, "\\u003c");
+}
+
+//#endregion
+export { escapeJsonLdForScript };

package/dist/tanstack-layout.d.mts

@@ -31,6 +31,7 @@ interface TanstackDocsLayoutProps {
   description?: string;
   readingTime?: number | null;
   lastModified?: string;
+  structuredData?: string;
   editOnGithubUrl?: string;
   children: ReactNode;
 }
@@ -41,6 +42,7 @@ declare function TanstackDocsLayout({
   description,
   readingTime,
   lastModified,
+  structuredData,
   editOnGithubUrl,
   children
 }: TanstackDocsLayoutProps): react_jsx_runtime0.JSX.Element;

package/dist/tanstack-layout.mjs

@@ -1,4 +1,5 @@
 import { withLangInUrl } from "./i18n.mjs";
+import { escapeJsonLdForScript } from "./json-ld.mjs";
 import { DocsPageClient } from "./docs-page-client.mjs";
 import { DocsAIFeatures } from "./docs-ai-features.mjs";
 import { DocsCommandSearch } from "./docs-command-search.mjs";
@@ -8,7 +9,7 @@ import { LocaleThemeControl } from "./locale-theme-control.mjs";
 import { DocsLayout } from "fumadocs-ui/layouts/docs";
 import { Suspense } from "react";
 import { applySidebarFolderIndexBehavior, resolveDocsAnalyticsConfig } from "@farming-labs/docs";
-import { jsx, jsxs } from "react/jsx-runtime";
+import { Fragment as Fragment$1, jsx, jsxs } from "react/jsx-runtime";
 
 //#region src/tanstack-layout.tsx
 function resolveTreeIcon(icon, registry) {
@@ -207,7 +208,7 @@ function resolveFeedbackConfig(feedback) {
 function ForcedThemeScript({ theme }) {
 	return /* @__PURE__ */ jsx("script", { dangerouslySetInnerHTML: { __html: `document.documentElement.classList.remove('light','dark');document.documentElement.classList.add('${theme === "light" || theme === "dark" ? theme : "light"}');` } });
 }
-function TanstackDocsLayout({ config, tree, locale, description, readingTime, lastModified, editOnGithubUrl, children }) {
+function TanstackDocsLayout({ config, tree, locale, description, readingTime, lastModified, structuredData, editOnGithubUrl, children }) {
 	const tocConfig = config.theme?.ui?.layout?.toc;
 	const tocEnabled = tocConfig?.enabled !== false;
 	const tocStyle = tocConfig?.style;
@@ -290,7 +291,7 @@ function TanstackDocsLayout({ config, tree, locale, description, readingTime, la
 		collapsible: sidebarProps.collapsible !== false,
 		flat: !!sidebarFlat
 	});
-	return /* @__PURE__ */ jsxs(DocsLayout, {
+	const layout = /* @__PURE__ */ jsxs(DocsLayout, {
 		tree: resolvedTree,
 		nav: {
 			title: navTitle,
@@ -364,6 +365,11 @@ function TanstackDocsLayout({ config, tree, locale, description, readingTime, la
 			})
 		]
 	});
+	if (!structuredData) return layout;
+	return /* @__PURE__ */ jsxs(Fragment$1, { children: [/* @__PURE__ */ jsx("script", {
+		type: "application/ld+json",
+		dangerouslySetInnerHTML: { __html: escapeJsonLdForScript(structuredData) }
+	}), layout] });
 }
 
 //#endregion

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@farming-labs/theme",
-  "version": "0.1.84",
+  "version": "0.1.86",
   "description": "Theme package for @farming-labs/docs — layout, provider, MDX components, and styles",
   "keywords": [
     "docs",
@@ -139,7 +139,7 @@
     "tsdown": "^0.20.3",
     "typescript": "^5.9.3",
     "vitest": "^3.2.4",
-    "@farming-labs/docs": "0.1.84"
+    "@farming-labs/docs": "0.1.86"
   },
   "peerDependencies": {
     "@farming-labs/docs": ">=0.0.1",