@farming-labs/theme 0.2.96 → 0.2.98

package/dist/docs-layout.mjs

@@ -35,6 +35,30 @@ function readFrontmatter(filePath) {
 		return {};
 	}
 }
+function hasAuthoredPageTitle(source) {
+	const { content } = matter(source);
+	const lines = content.split(/\r?\n/);
+	let fence;
+	let previousTextLine = "";
+	for (const line of lines) {
+		const fenceMatch = line.match(/^\s*(`{3,}|~{3,})/);
+		if (fenceMatch) {
+			const marker = fenceMatch[1]?.[0];
+			fence = fence === marker ? void 0 : fence ?? marker;
+			previousTextLine = "";
+			continue;
+		}
+		if (fence) continue;
+		if (/^ {0,3}#(?:\s+|$)/.test(line) || /^\s*<h1(?:\s|>)/i.test(line)) return true;
+		if (previousTextLine && /^ {0,3}=+\s*$/.test(line)) return true;
+		previousTextLine = line.trim() && !line.trimStart().startsWith("<") ? line : "";
+	}
+	return false;
+}
+function resolveSidebarFolderName(themeName, slug, pageTitle) {
+	if (themeName !== "shadcn" || pageTitle.trim().toLowerCase() !== "introduction") return pageTitle;
+	return slug.split(/[-_]/).filter(Boolean).map((part) => part[0]?.toUpperCase() + part.slice(1)).join(" ");
+}
 /** Check if a directory has any subdirectories that contain page.mdx. */
 function isWithinDir(candidate, target) {
 	const relative = path.relative(target, candidate);
@@ -194,12 +218,13 @@ function buildTree(config, ctx, flat = false) {
 		const url = publicDocsRoute(ctx, slug);
 		const icon = resolveIcon(data.icon, icons);
 		const displayName = data.title ?? name.replace(/-/g, " ");
+		const folderName = resolveSidebarFolderName(config.theme?.name, name, displayName);
 		const hasChildren = hasChildPages(full, excludedDirs);
 		if (data.hidden === true) {
 			if (!hasChildren) return null;
 			return {
 				type: "folder",
-				name: displayName,
+				name: folderName,
 				icon,
 				children: scanDir(full, slug, slugOrder),
 				...flat ? {
@@ -212,7 +237,7 @@ function buildTree(config, ctx, flat = false) {
 			const folderChildren = scanDir(full, slug, slugOrder);
 			return {
 				type: "folder",
-				name: displayName,
+				name: folderName,
 				icon,
 				index: {
 					type: "page",
@@ -380,6 +405,28 @@ function buildDescriptionMap(config, ctx) {
 	scan(docsDir, []);
 	return map;
 }
+/** Build titles only for pages whose MDX body does not already author an h1. */
+function buildGeneratedTitleMap(config, ctx) {
+	const docsDir = ctx.docsDir;
+	const map = {};
+	const excludedDirs = getExcludedDocsDirs(config, ctx);
+	function scan(dir, slugParts) {
+		if (!fs.existsSync(dir)) return;
+		if (isExcludedDir(dir, excludedDirs)) return;
+		const pagePath = findDocsPageFile(dir);
+		if (pagePath) {
+			const source = fs.readFileSync(pagePath, "utf-8");
+			const { data } = matter(source);
+			if (typeof data.title === "string" && !hasAuthoredPageTitle(source)) map[publicDocsRoute(ctx, slugParts)] = data.title;
+		}
+		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;
+}
 function buildReadingTimeMap(config, ctx, options) {
 	const docsDir = ctx.docsDir;
 	const map = {};
@@ -702,6 +749,7 @@ function createDocsLayout(config, options) {
 	}
 	const lastModifiedMap = buildLastModifiedMap(config, localeContext);
 	const descriptionMap = buildDescriptionMap(config, localeContext);
+	const generatedTitleMap = config.theme?.name === "shadcn" ? buildGeneratedTitleMap(config, localeContext) : {};
 	const readingTimeMap = buildReadingTimeMap(config, localeContext, {
 		enabledByDefault: readingTimeEnabledByDefault,
 		wordsPerMinute: readingTimeWordsPerMinute,
@@ -820,6 +868,7 @@ function createDocsLayout(config, options) {
 						readingTimeMap,
 						structuredDataMap,
 						llmsTxtEnabled,
+						generatedTitleMap,
 						descriptionMap,
 						feedbackEnabled: feedbackConfig.enabled,
 						feedbackQuestion: feedbackConfig.question,

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

@@ -78,6 +78,8 @@ interface DocsPageClientProps {
   lastUpdatedPosition?: "footer" | "below-title";
   /** Whether llms.txt is enabled — shows links in footer */
   llmsTxtEnabled?: boolean;
+  /** Frontmatter titles for pages whose MDX body does not author an h1 */
+  generatedTitleMap?: Record<string, string>;
   /** Map of pathname → frontmatter description */
   descriptionMap?: Record<string, string>;
   /** Frontmatter description to display below the page title (overrides descriptionMap) */
@@ -134,6 +136,7 @@ declare function DocsPageClient({
   lastUpdatedLabel,
   lastUpdatedPosition,
   llmsTxtEnabled,
+  generatedTitleMap,
   descriptionMap,
   description,
   feedbackEnabled,

package/dist/docs-page-client.mjs

@@ -255,7 +255,7 @@ function findThreadlineTocActionsContainer() {
 	}
 	return toc.parentElement ?? toc;
 }
-function DocsPageClient({ tocEnabled, tocStyle = "default", breadcrumbEnabled = true, changelogBasePath, entry = "docs", publicPath, locale, copyMarkdown = false, copyMarkdownFormat, copyMarkdownIncludeTitle, copyMarkdownLabel, copyMarkdownCopiedLabel, openDocs = false, openDocsProviders, openDocsTarget, openDocsPrompt, pageActionsPosition = "below-title", pageActionsAlignment = "left", githubUrl, contentDir, githubBranch = "main", githubDirectory, editOnGithubUrl, lastModifiedMap, lastModified: lastModifiedProp, readingTimeMap, readingTime: readingTimeProp, readingTimeFormat = "long", previousPage, nextPage, structuredDataMap, structuredData: structuredDataProp, readingTimeEnabled = false, lastUpdatedEnabled = true, lastUpdatedLabel = "Last updated", lastUpdatedPosition = "footer", llmsTxtEnabled = false, descriptionMap, description, feedbackEnabled = false, feedbackQuestion, feedbackPlaceholder, feedbackRequireComment, feedbackPositiveLabel, feedbackNegativeLabel, feedbackSubmitLabel, feedbackSuccessMessage, feedbackErrorMessage, feedbackOnFeedback, analytics = false, children }) {
+function DocsPageClient({ tocEnabled, tocStyle = "default", breadcrumbEnabled = true, changelogBasePath, entry = "docs", publicPath, locale, copyMarkdown = false, copyMarkdownFormat, copyMarkdownIncludeTitle, copyMarkdownLabel, copyMarkdownCopiedLabel, openDocs = false, openDocsProviders, openDocsTarget, openDocsPrompt, pageActionsPosition = "below-title", pageActionsAlignment = "left", githubUrl, contentDir, githubBranch = "main", githubDirectory, editOnGithubUrl, lastModifiedMap, lastModified: lastModifiedProp, readingTimeMap, readingTime: readingTimeProp, readingTimeFormat = "long", previousPage, nextPage, structuredDataMap, structuredData: structuredDataProp, readingTimeEnabled = false, lastUpdatedEnabled = true, lastUpdatedLabel = "Last updated", lastUpdatedPosition = "footer", llmsTxtEnabled = false, generatedTitleMap, descriptionMap, description, feedbackEnabled = false, feedbackQuestion, feedbackPlaceholder, feedbackRequireComment, feedbackPositiveLabel, feedbackNegativeLabel, feedbackSubmitLabel, feedbackSuccessMessage, feedbackErrorMessage, feedbackOnFeedback, analytics = false, children }) {
 	const fdTocStyle = tocStyle === "directional" ? "clerk" : void 0;
 	const [toc, setToc] = useState([]);
 	const [titlePortalHost, setTitlePortalHost] = useState(null);
@@ -268,8 +268,9 @@ function DocsPageClient({ tocEnabled, tocStyle = "default", breadcrumbEnabled =
 	const activeLocale = resolveClientLocale(searchParams, locale);
 	const resolvedPublicPath = normalizePublicDocsPath(publicPath, entry);
 	const llmsLangQuery = activeLocale ? `?lang=${encodeURIComponent(activeLocale)}` : "";
-	const pageDescription = description ?? descriptionMap?.[pathname.replace(/\/$/, "") || "/"];
 	const normalizedPath = (browserPathname || pathname).replace(/\/$/, "") || "/";
+	const pageTitle = generatedTitleMap?.[normalizedPath];
+	const pageDescription = description ?? descriptionMap?.[normalizedPath];
 	const isChangelogRoute = !!(changelogBasePath && (normalizedPath === changelogBasePath || normalizedPath.startsWith(`${changelogBasePath}/`)));
 	const matchedReadingTime = readingTimeMap?.[normalizedPath];
 	const structuredDataJson = !isChangelogRoute ? structuredDataProp ?? structuredDataMap?.[normalizedPath] : void 0;
@@ -495,7 +496,7 @@ function DocsPageClient({ tocEnabled, tocStyle = "default", breadcrumbEnabled =
 		]
 	}, "below-title") : void 0;
 	const decoratedChildren = children;
-	const needsTitleDecorationsPortal = !!titleDescription || !!belowTitleBlock;
+	const needsTitleDecorationsPortal = !pageTitle && (!!titleDescription || !!belowTitleBlock);
 	useEffect(() => {
 		if (!needsTitleDecorationsPortal) {
 			setTitlePortalHost(null);
@@ -521,6 +522,16 @@ function DocsPageClient({ tocEnabled, tocStyle = "default", breadcrumbEnabled =
 	}) : null;
 	const titleDecorationsPortal = titleDecorations && titlePortalHost ? createPortal(titleDecorations, titlePortalHost, "title-decorations") : null;
 	const titleDecorationsFallback = titleDecorations && !titlePortalHost ? titleDecorations : null;
+	const generatedPageHeader = pageTitle ? /* @__PURE__ */ jsxs("div", {
+		className: "fd-generated-page-header not-prose",
+		children: [/* @__PURE__ */ jsx("h1", {
+			className: "fd-page-title",
+			children: pageTitle
+		}), /* @__PURE__ */ jsx(TitleDecorations, {
+			description: titleDescription,
+			belowTitle: belowTitleBlock
+		})]
+	}) : null;
 	const titleControlsPortal = showActionsInToc && titleControlsPortalHost ? createPortal(/* @__PURE__ */ jsx(ThreadlinePageControls, {}), titleControlsPortalHost, "title-controls") : null;
 	const tocActionsPortal = showActionsInToc && tocActionsPortalHost ? createPortal(/* @__PURE__ */ jsx("div", {
 		className: "fd-actions-toc-portal not-prose",
@@ -604,11 +615,12 @@ function DocsPageClient({ tocEnabled, tocStyle = "default", breadcrumbEnabled =
 						flexDirection: "column"
 					},
 					children: [
+						generatedPageHeader,
 						/* @__PURE__ */ jsx("div", {
 							style: { flex: 1 },
 							children: renderedChildren
 						}, "content"),
-						titleDecorationsFallback,
+						!generatedPageHeader && titleDecorationsFallback,
 						titleDecorationsPortal,
 						!isChangelogRoute && feedbackEnabled && /* @__PURE__ */ jsx(DocsFeedback, {
 							pathname: normalizedPath,

package/package.json

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