@farming-labs/theme 0.0.2-beta.26 → 0.0.2-beta.28

package/dist/docs-layout.d.mts

@@ -14,20 +14,29 @@ import { DocsConfig } from "@farming-labs/docs";
  * export const metadata = createDocsMetadata(docsConfig);
  * ```
  */
-declare function createDocsMetadata(config: DocsConfig): {
-  twitter?: {
-    card: "summary" | "summary_large_image";
-  } | undefined;
-  description?: string | undefined;
-  title: {
-    template: string;
-    default: string;
-  };
-};
+declare function createDocsMetadata(config: DocsConfig): Record<string, unknown>;
+/**
+ * Generate page-level metadata with dynamic OG images.
+ *
+ * Usage in a docs page or [[...slug]] route:
+ * ```ts
+ * export function generateMetadata({ params }) {
+ *   const page = getPage(params.slug);
+ *   return createPageMetadata(docsConfig, {
+ *     title: page.data.title,
+ *     description: page.data.description,
+ *   });
+ * }
+ * ```
+ */
+declare function createPageMetadata(config: DocsConfig, page: {
+  title: string;
+  description?: string;
+}): Record<string, unknown>;
 declare function createDocsLayout(config: DocsConfig): ({
   children
 }: {
   children: ReactNode;
 }) => react_jsx_runtime0.JSX.Element;
 //#endregion
-export { createDocsLayout, createDocsMetadata };
+export { createDocsLayout, createDocsMetadata, createPageMetadata };

package/dist/docs-layout.mjs

@@ -204,15 +204,71 @@ function buildDescriptionMap(entry) {
 */
 function createDocsMetadata(config) {
 	const meta = config.metadata;
+	const og = config.og;
 	const template = meta?.titleTemplate ?? "%s";
-	return {
+	const defaultTitle = template.replace("%s", "").replace(/^[\s–—-]+/, "").trim() || "Docs";
+	const result = {
 		title: {
 			template,
-			default: template.replace("%s", "").replace(/^[\s–—-]+/, "").trim() || "Docs"
+			default: defaultTitle
 		},
 		...meta?.description ? { description: meta.description } : {},
 		...meta?.twitterCard ? { twitter: { card: meta.twitterCard } } : {}
 	};
+	if (og?.enabled !== false && og?.endpoint) {
+		const ogUrl = `${og.endpoint}?title=${encodeURIComponent(defaultTitle)}${meta?.description ? `&description=${encodeURIComponent(meta.description)}` : ""}`;
+		result.openGraph = { images: [{
+			url: ogUrl,
+			width: 1200,
+			height: 630
+		}] };
+		result.twitter = {
+			...result.twitter,
+			card: meta?.twitterCard ?? "summary_large_image",
+			images: [ogUrl]
+		};
+	}
+	return result;
+}
+/**
+* Generate page-level metadata with dynamic OG images.
+*
+* Usage in a docs page or [[...slug]] route:
+* ```ts
+* export function generateMetadata({ params }) {
+*   const page = getPage(params.slug);
+*   return createPageMetadata(docsConfig, {
+*     title: page.data.title,
+*     description: page.data.description,
+*   });
+* }
+* ```
+*/
+function createPageMetadata(config, page) {
+	const og = config.og;
+	const result = {
+		title: page.title,
+		...page.description ? { description: page.description } : {}
+	};
+	if (og?.enabled !== false && og?.endpoint) {
+		const ogUrl = `${og.endpoint}?title=${encodeURIComponent(page.title)}${page.description ? `&description=${encodeURIComponent(page.description)}` : ""}`;
+		result.openGraph = {
+			title: page.title,
+			description: page.description,
+			images: [{
+				url: ogUrl,
+				width: 1200,
+				height: 630
+			}]
+		};
+		result.twitter = {
+			card: "summary_large_image",
+			title: page.title,
+			description: page.description,
+			images: [ogUrl]
+		};
+	}
+	return result;
 }
 /** Resolve the themeToggle config into fumadocs-ui's `themeSwitch` prop. */
 function resolveThemeSwitch(toggle) {
@@ -452,4 +508,4 @@ function ForcedThemeScript({ theme }) {
 }
 
 //#endregion
-export { createDocsLayout, createDocsMetadata };
+export { createDocsLayout, createDocsMetadata, createPageMetadata };

package/dist/docs-page-client.mjs

@@ -53,15 +53,15 @@ function PathBreadcrumb({ pathname, entry }) {
 * (Copy Markdown, Open in LLM). Re-scans when the route changes.
 */
 /**
-* Build the GitHub URL for the current page's source file.
+* Build the GitHub URL for the current page's source file (edit view).
 *
 * Examples:
-*   No directory:  https://github.com/user/repo/tree/main/app/docs/cli/page.mdx
-*   With directory: https://github.com/farming-labs/docs/tree/main/website/app/docs/cli/page.mdx
+*   No directory:  https://github.com/user/repo/edit/main/app/docs/cli/page.mdx
+*   With directory: https://github.com/farming-labs/docs/edit/main/website/app/docs/cli/page.mdx
 */
 function buildGithubFileUrl(githubUrl, branch, pathname, directory) {
 	const segments = pathname.replace(/^\//, "").replace(/\/$/, "");
-	return `${githubUrl}/tree/${branch}/${directory ? `${directory}/` : ""}app/${segments}/page.mdx`;
+	return `${githubUrl}/edit/${branch}/${`${directory ? `${directory}/` : ""}app/${segments}/page.mdx`}`;
 }
 function DocsPageClient({ tocEnabled, tocStyle = "default", breadcrumbEnabled = true, entry = "docs", copyMarkdown = false, openDocs = false, openDocsProviders, pageActionsPosition = "below-title", pageActionsAlignment = "left", githubUrl, githubBranch = "main", githubDirectory, lastModifiedMap, lastUpdatedEnabled = true, lastUpdatedPosition = "footer", llmsTxtEnabled = false, descriptionMap, description, children }) {
 	const fdTocStyle = tocStyle === "directional" ? "clerk" : void 0;
@@ -176,7 +176,8 @@ function DocsPageClient({ tocEnabled, tocStyle = "default", breadcrumbEnabled =
 			showActions && actionsPortalTarget && createPortal(/* @__PURE__ */ jsx(PageActions, {
 				copyMarkdown,
 				openDocs,
-				providers: openDocsProviders
+				providers: openDocsProviders,
+				githubFileUrl
 			}), actionsPortalTarget),
 			/* @__PURE__ */ jsxs(DocsBody, {
 				style: {

package/dist/index.d.mts

@@ -1,6 +1,6 @@
 import { DefaultUIDefaults, fumadocs } from "./default/index.mjs";
 import { DocsCommandSearch } from "./docs-command-search.mjs";
-import { createDocsLayout, createDocsMetadata } from "./docs-layout.mjs";
+import { createDocsLayout, createDocsMetadata, createPageMetadata } from "./docs-layout.mjs";
 import { DocsPageClient } from "./docs-page-client.mjs";
 import { RootProvider } from "./provider.mjs";
 import { PageActions } from "./page-actions.mjs";
@@ -9,4 +9,4 @@ import { DocsBody, DocsPage } from "fumadocs-ui/layouts/docs/page";
 import { AIConfig, BreadcrumbConfig, CopyMarkdownConfig, DocsConfig, DocsMetadata, DocsNav, DocsTheme, FontStyle, OGConfig, OpenDocsConfig, OpenDocsProvider, PageActionsConfig, PageFrontmatter, SidebarConfig, ThemeToggleConfig, TypographyConfig, UIConfig, createTheme, deepMerge, defineDocs, extendTheme } from "@farming-labs/docs";
 import { Tab, Tabs } from "fumadocs-ui/components/tabs";
 import { CodeBlock, CodeBlockTab, CodeBlockTabs, CodeBlockTabsList, CodeBlockTabsTrigger, Pre } from "fumadocs-ui/components/codeblock";
-export { type AIConfig, type BreadcrumbConfig, CodeBlock, CodeBlockTab, CodeBlockTabs, CodeBlockTabsList, CodeBlockTabsTrigger, type CopyMarkdownConfig, DocsBody, DocsCommandSearch, type DocsConfig, DocsLayout, type DocsMetadata, type DocsNav, DocsPage, DocsPageClient, type DocsTheme, type FontStyle, DefaultUIDefaults as FumadocsUIDefaults, type OGConfig, type OpenDocsConfig, type OpenDocsProvider, PageActions, type PageActionsConfig, type PageFrontmatter, Pre, RootProvider, type SidebarConfig, Tab, Tabs, type ThemeToggleConfig, type TypographyConfig, type UIConfig, createDocsLayout, createDocsMetadata, createTheme, deepMerge, defineDocs, extendTheme, fumadocs };
+export { type AIConfig, type BreadcrumbConfig, CodeBlock, CodeBlockTab, CodeBlockTabs, CodeBlockTabsList, CodeBlockTabsTrigger, type CopyMarkdownConfig, DocsBody, DocsCommandSearch, type DocsConfig, DocsLayout, type DocsMetadata, type DocsNav, DocsPage, DocsPageClient, type DocsTheme, type FontStyle, DefaultUIDefaults as FumadocsUIDefaults, type OGConfig, type OpenDocsConfig, type OpenDocsProvider, PageActions, type PageActionsConfig, type PageFrontmatter, Pre, RootProvider, type SidebarConfig, Tab, Tabs, type ThemeToggleConfig, type TypographyConfig, type UIConfig, createDocsLayout, createDocsMetadata, createPageMetadata, createTheme, deepMerge, defineDocs, extendTheme, fumadocs };

package/dist/index.mjs

@@ -1,7 +1,7 @@
 import { DocsCommandSearch } from "./docs-command-search.mjs";
 import { PageActions } from "./page-actions.mjs";
 import { DocsPageClient } from "./docs-page-client.mjs";
-import { createDocsLayout, createDocsMetadata } from "./docs-layout.mjs";
+import { createDocsLayout, createDocsMetadata, createPageMetadata } from "./docs-layout.mjs";
 import { RootProvider } from "./provider.mjs";
 import { DefaultUIDefaults, fumadocs } from "./default/index.mjs";
 import { DocsLayout } from "fumadocs-ui/layouts/docs";
@@ -10,4 +10,4 @@ import { createTheme, deepMerge, defineDocs, extendTheme } from "@farming-labs/d
 import { Tab, Tabs } from "fumadocs-ui/components/tabs";
 import { CodeBlock, CodeBlockTab, CodeBlockTabs, CodeBlockTabsList, CodeBlockTabsTrigger, Pre } from "fumadocs-ui/components/codeblock";
 
-export { CodeBlock, CodeBlockTab, CodeBlockTabs, CodeBlockTabsList, CodeBlockTabsTrigger, DocsBody, DocsCommandSearch, DocsLayout, DocsPage, DocsPageClient, DefaultUIDefaults as FumadocsUIDefaults, PageActions, Pre, RootProvider, Tab, Tabs, createDocsLayout, createDocsMetadata, createTheme, deepMerge, defineDocs, extendTheme, fumadocs };
+export { CodeBlock, CodeBlockTab, CodeBlockTabs, CodeBlockTabsList, CodeBlockTabsTrigger, DocsBody, DocsCommandSearch, DocsLayout, DocsPage, DocsPageClient, DefaultUIDefaults as FumadocsUIDefaults, PageActions, Pre, RootProvider, Tab, Tabs, createDocsLayout, createDocsMetadata, createPageMetadata, createTheme, deepMerge, defineDocs, extendTheme, fumadocs };

package/dist/page-actions.d.mts

@@ -11,11 +11,14 @@ interface PageActionsProps {
   copyMarkdown?: boolean;
   openDocs?: boolean;
   providers?: SerializedProvider[];
+  /** GitHub file URL (edit view) for the current page. Used when urlTemplate contains {githubUrl}. */
+  githubFileUrl?: string | null;
 }
 declare function PageActions({
   copyMarkdown,
   openDocs,
-  providers
+  providers,
+  githubFileUrl
 }: PageActionsProps): react_jsx_runtime0.JSX.Element | null;
 //#endregion
 export { PageActions };

package/dist/page-actions.mjs

@@ -72,7 +72,7 @@ const DEFAULT_PROVIDERS = [{
 	name: "Claude",
 	urlTemplate: "https://claude.ai/new?q=Read+{mdxUrl},+I+want+to+ask+questions+about+it."
 }];
-function PageActions({ copyMarkdown, openDocs, providers }) {
+function PageActions({ copyMarkdown, openDocs, providers, githubFileUrl }) {
 	const [copied, setCopied] = useState(false);
 	const [dropdownOpen, setDropdownOpen] = useState(false);
 	const dropdownRef = useRef(null);
@@ -89,12 +89,16 @@ function PageActions({ copyMarkdown, openDocs, providers }) {
 		} catch {}
 	}, []);
 	const handleOpen = useCallback((template) => {
+		if (/\{githubUrl\}/.test(template) && !githubFileUrl) {
+			setDropdownOpen(false);
+			return;
+		}
 		const pageUrl = window.location.href;
 		const mdxUrl = `${window.location.origin}${pathname}.mdx`;
-		const url = template.replace(/\{url\}/g, encodeURIComponent(pageUrl)).replace(/\{mdxUrl\}/g, encodeURIComponent(mdxUrl));
+		let url = template.replace(/\{url\}/g, encodeURIComponent(pageUrl)).replace(/\{mdxUrl\}/g, encodeURIComponent(mdxUrl)).replace(/\{githubUrl\}/g, githubFileUrl ?? "");
 		window.open(url, "_blank", "noopener,noreferrer");
 		setDropdownOpen(false);
-	}, [pathname]);
+	}, [pathname, githubFileUrl]);
 	useEffect(() => {
 		if (!dropdownOpen) return;
 		function handleClick(e) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@farming-labs/theme",
-  "version": "0.0.2-beta.26",
+  "version": "0.0.2-beta.28",
   "description": "Theme package for @farming-labs/docs — layout, provider, MDX components, and styles",
   "keywords": [
     "docs",
@@ -98,7 +98,7 @@
     "next": ">=14.0.0",
     "tsdown": "^0.20.3",
     "typescript": "^5.9.3",
-    "@farming-labs/docs": "0.0.2-beta.26"
+    "@farming-labs/docs": "0.0.2-beta.28"
   },
   "peerDependencies": {
     "@farming-labs/docs": ">=0.0.1",

package/styles/pixel-border.css

@@ -450,11 +450,13 @@ figure.shiki > div:first-child {
 }
 
 /* ─── Page Actions (pixel-border overrides) ───────────────────────── */
-
 .fd-page-action-btn {
   border-radius: 0 !important;
   font-size: 0.75rem;
   letter-spacing: 0.03em;
+  text-transform: uppercase;
+  box-shadow: 2px 2px 0 0 var(--color-fd-border, #262626);
+  font-family: var(--fd-font-mono, var(--font-geist-mono, ui-monospace, monospace)) !important;
 }
 
 .fd-page-action-menu {