@farming-labs/next 0.2.120 → 0.2.121

package/README.md

@@ -61,6 +61,35 @@ Import the selected theme in your global stylesheet:
 Write documentation pages under `app/docs/` or `src/app/docs/`. The CLI also adds the root
 `RootProvider`, generated docs layout, and server routes needed for a complete setup.
 
+## Extending MDX compilation
+
+Pass adapter options as the third `withDocs` argument. Plugin module names (or absolute paths)
+and JSON options work with both Webpack and Turbopack:
+
+```ts
+import { withDocs } from "@farming-labs/next/config";
+import docsConfig from "./docs.config";
+
+export default withDocs({}, docsConfig, {
+  mdx: {
+    remarkPlugins: ["remark-directive"],
+    rehypePlugins: [["rehype-external-links", { target: "_blank" }]],
+  },
+});
+```
+
+Install the plugins in your application. Extra plugins run after the built-in plugins in their
+respective phase; frontmatter, heading IDs, TOC, Markdown alternate links, and syntax highlighting
+remain enabled. Put callbacks and other non-JSON configuration inside a local plugin module and
+pass its absolute path, for example `import.meta.resolve("./plugins/highlight.mjs")` converted
+with `fileURLToPath` from `node:url`.
+
+For a migration with its own highlighter, set `mdx.codeHighlighter` to that plugin's module name
+or `[module, options]` tuple. This replaces only the default code-highlighting step, so code is
+highlighted once. The custom plugin owns its theme and code-block behavior. Omitting `mdx` keeps
+the existing defaults. Use `undefined` as the second argument if you are not passing a live docs
+config. These hooks do not configure Fumadocs collections or replace its source loader.
+
 ## Main entrypoints
 
 | Entrypoint | Purpose |
@@ -75,7 +104,7 @@ Write documentation pages under `app/docs/` or `src/app/docs/`. The CLI also add
 
 - Next.js 16 or newer
 - React and React DOM 19.2 or newer
-- `@farming-labs/docs` and `@farming-labs/theme`
+- `@farming-labs/docs` 0.2.121 or newer and `@farming-labs/theme`
 
 ## Learn more
 

package/dist/api-reference-CTAOPJih.d.mts

@@ -0,0 +1,49 @@
+import { DocsConfig } from "@farming-labs/docs";
+import { resolveApiReferenceConfig as resolveApiReferenceConfig$1 } from "@farming-labs/docs/runtime";
+import { ReactNode } from "react";
+import * as react_jsx_runtime0 from "react/jsx-runtime";
+
+//#region src/api-reference-banner.d.ts
+declare function withNextApiReferenceBanner(config: DocsConfig): DocsConfig;
+//#endregion
+//#region src/api-reference.d.ts
+interface NextApiReferenceSourceState {
+  apiReference: ReturnType<typeof resolveApiReferenceConfig$1>;
+  document: Record<string, unknown>;
+  info: {
+    title: string;
+    description?: string;
+  };
+  primaryServerUrl?: string;
+  pages: Array<{
+    url: string;
+  } & Record<string, any>>;
+  server: any;
+  source: {
+    getPage: (slug?: string[]) => any;
+    getPages: () => Array<any>;
+    getPageTree: () => any;
+  };
+}
+declare function buildNextOpenApiDocument(config: DocsConfig): Record<string, unknown>;
+declare function flattenApiReferencePageTreeForSidebar(tree: any): any;
+declare function createNextApiReference(config: DocsConfig): (request?: Request) => Promise<Response>;
+declare function createNextApiReferencePage(config: DocsConfig): (props?: {
+  params?: Promise<{
+    slug?: string[];
+  }> | {
+    slug?: string[];
+  };
+}) => Promise<react_jsx_runtime0.JSX.Element>;
+declare function createNextApiReferenceLayout(config: DocsConfig): (props: {
+  children: React.ReactNode;
+  params?: Promise<{
+    slug?: string[];
+  }> | {
+    slug?: string[];
+  };
+}) => Promise<react_jsx_runtime0.JSX.Element>;
+declare function getNextApiReferenceSourceState(config: DocsConfig, versionId?: string): Promise<NextApiReferenceSourceState>;
+declare function getNextApiReferenceMode(config: DocsConfig): "farming-labs" | "fumadocs" | "scalar";
+//#endregion
+export { createNextApiReferencePage as a, getNextApiReferenceSourceState as c, createNextApiReferenceLayout as i, resolveApiReferenceConfig$1 as l, buildNextOpenApiDocument as n, flattenApiReferencePageTreeForSidebar as o, createNextApiReference as r, getNextApiReferenceMode as s, NextApiReferenceSourceState as t, withNextApiReferenceBanner as u };

package/dist/api-reference-banner-q98BnSRL.mjs

@@ -0,0 +1,94 @@
+import { resolveApiReferenceConfig } from "@farming-labs/docs/runtime";
+import { jsx, jsxs } from "react/jsx-runtime";
+import { SidebarTabsDropdown } from "fumadocs-ui/components/sidebar/tabs/dropdown";
+
+//#region src/api-reference-banner.tsx
+function getDocsUrl(config) {
+	if (typeof config.nav?.url === "string") return config.nav.url;
+	return `/${config.entry ?? "docs"}`;
+}
+function SwitcherGlyph({ kind }) {
+	const isApi = kind === "api";
+	return /* @__PURE__ */ jsx("span", {
+		className: "fd-api-reference-switcher-glyph",
+		"data-kind": kind,
+		"aria-hidden": "true",
+		children: isApi ? /* @__PURE__ */ jsx("svg", {
+			viewBox: "0 0 24 24",
+			fill: "none",
+			children: /* @__PURE__ */ jsx("path", {
+				d: "M8 8L4 12L8 16M16 8L20 12L16 16M13.5 6L10.5 18",
+				stroke: "currentColor",
+				strokeWidth: "1.8",
+				strokeLinecap: "round",
+				strokeLinejoin: "round"
+			})
+		}) : /* @__PURE__ */ jsx("svg", {
+			viewBox: "0 0 24 24",
+			fill: "none",
+			children: /* @__PURE__ */ jsx("path", {
+				d: "M4.75 6.75C4.75 5.64543 5.64543 4.75 6.75 4.75H11.25V19.25H6.75C5.64543 19.25 4.75 18.3546 4.75 17.25V6.75ZM12.75 4.75H17.25C18.3546 4.75 19.25 5.64543 19.25 6.75V17.25C19.25 18.3546 18.3546 19.25 17.25 19.25H12.75V4.75Z",
+				stroke: "currentColor",
+				strokeWidth: "1.8",
+				strokeLinejoin: "round"
+			})
+		})
+	});
+}
+function ApiReferenceSwitcher({ docsUrl, apiUrl }) {
+	return /* @__PURE__ */ jsx(SidebarTabsDropdown, {
+		className: "fd-api-reference-switcher w-full mb-4",
+		options: [{
+			url: docsUrl,
+			title: "Documentation",
+			description: "Guides & concepts",
+			icon: /* @__PURE__ */ jsx(SwitcherGlyph, { kind: "docs" })
+		}, {
+			url: apiUrl,
+			title: "API Reference",
+			description: "Endpoints & examples",
+			icon: /* @__PURE__ */ jsx(SwitcherGlyph, { kind: "api" })
+		}]
+	});
+}
+function getExistingSidebarBanner(config) {
+	if (!config.sidebar || config.sidebar === true) return void 0;
+	return config.sidebar.banner;
+}
+function mergeBanner(existing, next) {
+	if (!existing) return next;
+	return /* @__PURE__ */ jsxs("div", {
+		style: {
+			display: "flex",
+			flexDirection: "column",
+			gap: 12
+		},
+		children: [existing, next]
+	});
+}
+function withNextApiReferenceBanner(config) {
+	const apiReference = resolveApiReferenceConfig(config.apiReference);
+	if (!apiReference.enabled) return config;
+	if (config.sidebar === false) return config;
+	const switcher = /* @__PURE__ */ jsx(ApiReferenceSwitcher, {
+		docsUrl: getDocsUrl(config),
+		apiUrl: `/${apiReference.path}`,
+		current: "docs",
+		config
+	});
+	const banner = mergeBanner(getExistingSidebarBanner(config), switcher);
+	if (!config.sidebar || config.sidebar === true) return {
+		...config,
+		sidebar: { banner }
+	};
+	return {
+		...config,
+		sidebar: {
+			...config.sidebar,
+			banner
+		}
+	};
+}
+
+//#endregion
+export { withNextApiReferenceBanner as a, mergeBanner as i, getDocsUrl as n, getExistingSidebarBanner as r, ApiReferenceSwitcher as t };

package/dist/api-reference.d.mts

@@ -1,47 +1,3 @@
+import { a as createNextApiReferencePage, c as getNextApiReferenceSourceState, i as createNextApiReferenceLayout, l as resolveApiReferenceConfig, n as buildNextOpenApiDocument, o as flattenApiReferencePageTreeForSidebar, r as createNextApiReference, s as getNextApiReferenceMode, t as NextApiReferenceSourceState, u as withNextApiReferenceBanner } from "./api-reference-CTAOPJih.mjs";
 import { FumadocsApiReferenceRendererOptions, fumadocsRenderer } from "./fumadocs-renderer.mjs";
-import { DocsConfig } from "@farming-labs/docs";
-import { resolveApiReferenceConfig } from "@farming-labs/docs/runtime";
-import * as react_jsx_runtime0 from "react/jsx-runtime";
-
-//#region src/api-reference.d.ts
-interface NextApiReferenceSourceState {
-  apiReference: ReturnType<typeof resolveApiReferenceConfig>;
-  document: Record<string, unknown>;
-  info: {
-    title: string;
-    description?: string;
-  };
-  primaryServerUrl?: string;
-  pages: Array<{
-    url: string;
-  } & Record<string, any>>;
-  server: any;
-  source: {
-    getPage: (slug?: string[]) => any;
-    getPages: () => Array<any>;
-    getPageTree: () => any;
-  };
-}
-declare function buildNextOpenApiDocument(config: DocsConfig): Record<string, unknown>;
-declare function flattenApiReferencePageTreeForSidebar(tree: any): any;
-declare function withNextApiReferenceBanner(config: DocsConfig): DocsConfig;
-declare function createNextApiReference(config: DocsConfig): (request?: Request) => Promise<Response>;
-declare function createNextApiReferencePage(config: DocsConfig): (props?: {
-  params?: Promise<{
-    slug?: string[];
-  }> | {
-    slug?: string[];
-  };
-}) => Promise<react_jsx_runtime0.JSX.Element>;
-declare function createNextApiReferenceLayout(config: DocsConfig): (props: {
-  children: React.ReactNode;
-  params?: Promise<{
-    slug?: string[];
-  }> | {
-    slug?: string[];
-  };
-}) => Promise<react_jsx_runtime0.JSX.Element>;
-declare function getNextApiReferenceSourceState(config: DocsConfig, versionId?: string): Promise<NextApiReferenceSourceState>;
-declare function getNextApiReferenceMode(config: DocsConfig): "farming-labs" | "fumadocs" | "scalar";
-//#endregion
-export { type FumadocsApiReferenceRendererOptions, NextApiReferenceSourceState, buildNextOpenApiDocument, createNextApiReference, createNextApiReferenceLayout, createNextApiReferencePage, flattenApiReferencePageTreeForSidebar, fumadocsRenderer, getNextApiReferenceMode, getNextApiReferenceSourceState, resolveApiReferenceConfig, withNextApiReferenceBanner };
+export { FumadocsApiReferenceRendererOptions, NextApiReferenceSourceState, buildNextOpenApiDocument, createNextApiReference, createNextApiReferenceLayout, createNextApiReferencePage, flattenApiReferencePageTreeForSidebar, fumadocsRenderer, getNextApiReferenceMode, getNextApiReferenceSourceState, resolveApiReferenceConfig, withNextApiReferenceBanner };

package/dist/api-reference.mjs

@@ -1,12 +1,12 @@
 import DocsClientCallbacks from "./client-callbacks.mjs";
 import FumadocsOpenAPIPage from "./fumadocs-api-page.mjs";
+import { a as withNextApiReferenceBanner, i as mergeBanner, n as getDocsUrl, r as getExistingSidebarBanner, t as ApiReferenceSwitcher } from "./api-reference-banner-q98BnSRL.mjs";
 import { fumadocsRenderer } from "./fumadocs-renderer.mjs";
 import { existsSync, readFileSync, readdirSync, statSync } from "node:fs";
 import { join, relative } from "node:path";
-import { resolveDocsMetadataBaseUrl } from "@farming-labs/docs";
 import { ApiReference } from "@scalar/nextjs-api-reference";
+import { resolveDocsMetadataBaseUrl } from "@farming-labs/docs";
 import { buildApiReferenceHtmlDocumentAsync, buildApiReferenceOpenApiDocumentAsync, buildApiReferencePageTitle, buildApiReferenceScalarCss, createApiReferenceOperationMarkdownResponse, resolveApiReferenceConfig, resolveApiReferenceRenderer, resolveApiReferenceVersion, resolveApiReferenceVersionFromPathname } from "@farming-labs/docs/runtime";
-import { SidebarTabsDropdown } from "fumadocs-ui/components/sidebar/tabs/dropdown";
 import Link from "next/link";
 import { notFound } from "next/navigation";
 import { Fragment, jsx, jsxs } from "react/jsx-runtime";
@@ -122,10 +122,6 @@ function scanRouteFiles(dir) {
 	}
 	return results;
 }
-function getDocsUrl(config) {
-	if (typeof config.nav?.url === "string") return config.nav.url;
-	return `/${config.entry ?? "docs"}`;
-}
 function getForcedMode(config) {
 	const toggle = config.themeToggle;
 	if (!toggle || typeof toggle !== "object") return void 0;
@@ -301,34 +297,6 @@ function buildNextOpenApiDocument(config) {
 		paths: buildOpenApiPaths(routes)
 	};
 }
-function SwitcherGlyph({ kind }) {
-	const isApi = kind === "api";
-	return /* @__PURE__ */ jsx("span", {
-		className: "fd-api-reference-switcher-glyph",
-		"data-kind": kind,
-		"aria-hidden": "true",
-		children: isApi ? /* @__PURE__ */ jsx("svg", {
-			viewBox: "0 0 24 24",
-			fill: "none",
-			children: /* @__PURE__ */ jsx("path", {
-				d: "M8 8L4 12L8 16M16 8L20 12L16 16M13.5 6L10.5 18",
-				stroke: "currentColor",
-				strokeWidth: "1.8",
-				strokeLinecap: "round",
-				strokeLinejoin: "round"
-			})
-		}) : /* @__PURE__ */ jsx("svg", {
-			viewBox: "0 0 24 24",
-			fill: "none",
-			children: /* @__PURE__ */ jsx("path", {
-				d: "M4.75 6.75C4.75 5.64543 5.64543 4.75 6.75 4.75H11.25V19.25H6.75C5.64543 19.25 4.75 18.3546 4.75 17.25V6.75ZM12.75 4.75H17.25C18.3546 4.75 19.25 5.64543 19.25 6.75V17.25C19.25 18.3546 18.3546 19.25 17.25 19.25H12.75V4.75Z",
-				stroke: "currentColor",
-				strokeWidth: "1.8",
-				strokeLinejoin: "round"
-			})
-		})
-	});
-}
 const API_REFERENCE_COLOR_MAP = {
 	primary: "--color-fd-primary",
 	primaryForeground: "--color-fd-primary-foreground",
@@ -490,40 +458,9 @@ function ApiReferenceServerUrlPatchScript({ serverUrl }) {
   })();` }
 	});
 }
-function ApiReferenceSwitcher({ docsUrl, apiUrl }) {
-	return /* @__PURE__ */ jsx(SidebarTabsDropdown, {
-		className: "fd-api-reference-switcher w-full mb-4",
-		options: [{
-			url: docsUrl,
-			title: "Documentation",
-			description: "Guides & concepts",
-			icon: /* @__PURE__ */ jsx(SwitcherGlyph, { kind: "docs" })
-		}, {
-			url: apiUrl,
-			title: "API Reference",
-			description: "Endpoints & examples",
-			icon: /* @__PURE__ */ jsx(SwitcherGlyph, { kind: "api" })
-		}]
-	});
-}
-function getExistingSidebarBanner(config) {
-	if (!config.sidebar || config.sidebar === true) return void 0;
-	return config.sidebar.banner;
-}
 function resolveApiReferenceThemeStyle(config) {
 	if ((config.theme?.name?.toLowerCase() ?? "").includes("colorful")) return "colorful";
 }
-function mergeBanner(existing, next) {
-	if (!existing) return next;
-	return /* @__PURE__ */ jsxs("div", {
-		style: {
-			display: "flex",
-			flexDirection: "column",
-			gap: 12
-		},
-		children: [existing, next]
-	});
-}
 function flattenApiReferencePageTreeForSidebar(tree) {
 	if (!tree || typeof tree !== "object") return tree;
 	const root = tree;
@@ -539,29 +476,6 @@ function flattenApiReferencePageTreeForSidebar(tree) {
 		children: nextChildren
 	};
 }
-function withNextApiReferenceBanner(config) {
-	const apiReference = resolveApiReferenceConfig(config.apiReference);
-	if (!apiReference.enabled) return config;
-	if (config.sidebar === false) return config;
-	const switcher = /* @__PURE__ */ jsx(ApiReferenceSwitcher, {
-		docsUrl: getDocsUrl(config),
-		apiUrl: `/${apiReference.path}`,
-		current: "docs",
-		config
-	});
-	const banner = mergeBanner(getExistingSidebarBanner(config), switcher);
-	if (!config.sidebar || config.sidebar === true) return {
-		...config,
-		sidebar: { banner }
-	};
-	return {
-		...config,
-		sidebar: {
-			...config.sidebar,
-			banner
-		}
-	};
-}
 function createNextApiReference(config) {
 	const apiReference = resolveApiReferenceConfig(config.apiReference);
 	return async (request) => {