fumapress 0.2.4 → 0.2.5

package/css/generated.css

@@ -6,20 +6,24 @@
 @source inline("await");
 @source inline("body");
 @source inline("border-b");
+@source inline("children");
 @source inline("className");
 @source inline("client");
 @source inline("const");
 @source inline("core:docs-layout");
 @source inline("core:home-layout");
+@source inline("core:notebook-layout");
 @source inline("core:provider");
 @source inline("core:render-body");
 @source inline("core:render-toc");
 @source inline("create");
 @source inline("createDocsLayout");
 @source inline("createHomeLayout");
+@source inline("createNotebookLayout");
 @source inline("createRootLayout");
 @source inline("data");
 @source inline("data-version");
+@source inline("date");
 @source inline("default");
 @source inline("else");
 @source inline("empty");
@@ -52,6 +56,7 @@
 @source inline("lang");
 @source inline("language");
 @source inline("languages");
+@source inline("lastModified");
 @source inline("layoutData");
 @source inline("layoutProps");
 @source inline("let");
@@ -69,6 +74,7 @@
 @source inline("page");
 @source inline("pageProps");
 @source inline("pb-6");
+@source inline("props");
 @source inline("providerProps");
 @source inline("pt-2");
 @source inline("query");
@@ -76,7 +82,6 @@
 @source inline("react");
 @source inline("render");
 @source inline("renderCtx");
-@source inline("renderPageMeta");
 @source inline("renderRootMeta");
 @source inline("result");
 @source inline("return");

package/dist/index.d.ts

@@ -1,4 +1,4 @@
 import { AppContext, AppContextData } from "./lib/shared.js";
 import { BuildMode, Config, ConfigBuilder, ConfigContext, I18nConfig, I18nConfigBuilder, Layouts, SiteConfig, defineConfig, defineI18nConfig } from "./config.js";
-import { Adapter, ServerPlugin } from "./lib/types.js";
-export { type Adapter, type AppContext, type AppContextData, BuildMode, Config, ConfigBuilder, ConfigContext, I18nConfig, I18nConfigBuilder, Layouts, type ServerPlugin, SiteConfig, defineConfig, defineI18nConfig };
+import { Adapter, RouteFns, ServerPlugin } from "./lib/types.js";
+export { type Adapter, type AppContext, type AppContextData, BuildMode, Config, ConfigBuilder, ConfigContext, I18nConfig, I18nConfigBuilder, Layouts, type RouteFns, type ServerPlugin, SiteConfig, defineConfig, defineI18nConfig };

package/dist/layouts/docs.d.ts

@@ -1,4 +1,4 @@
-import { AppContext } from "../lib/shared.js";
+import { AppContext, TransformChildren } from "../lib/shared.js";
 import { ConfigContext, Layouts } from "../config.js";
 import { Awaitable } from "../lib/types.js";
 import { ReactNode } from "react";
@@ -12,16 +12,18 @@ interface DocsLayoutOptions<C extends ConfigContext = ConfigContext> {
     lang?: string;
   }, page: C["loaderConfig"]["page"]) => Awaitable<{
     markdownUrl?: string;
+    lastModified?: Date | null;
     body?: ReactNode;
-    layoutProps?: Partial<DocsLayoutProps>;
-    pageProps?: DocsPageProps;
+    layoutProps?: TransformChildren<Partial<DocsLayoutProps>>;
+    pageProps?: TransformChildren<DocsPageProps>;
   }>;
 }
 interface DocsLayoutRenderData {
   markdownUrl?: string;
+  lastModified?: Date | null;
   body: ReactNode;
-  layoutProps: DocsLayoutProps;
-  pageProps: DocsPageProps;
+  layoutProps: TransformChildren<DocsLayoutProps>;
+  pageProps: TransformChildren<DocsPageProps>;
 }
 interface DocsLayoutContextData {
   renderers?: ((this: {

package/dist/layouts/docs.js

@@ -1,8 +1,8 @@
-import { baseOptions, getGitHubFileUrl, renderPageMeta } from "../lib/shared.js";
+import { TransformChildrenSlot, baseOptions, getGitHubFileUrl, renderPageMeta } from "../lib/shared.js";
 import { jsx, jsxs } from "react/jsx-runtime";
 import { unstable_notFound } from "waku/router/server";
 import { DocsLayout } from "fumadocs-ui/layouts/docs";
-import { DocsBody, DocsDescription, DocsPage, DocsTitle, MarkdownCopyButton, ViewOptionsPopover } from "fumadocs-ui/layouts/docs/page";
+import { DocsBody, DocsDescription, DocsPage, DocsTitle, MarkdownCopyButton, PageLastUpdate, ViewOptionsPopover } from "fumadocs-ui/layouts/docs/page";
 //#region src/layouts/docs.tsx
 function createDocsLayout({ render } = {}) {
 	async function defaultRender(page) {
@@ -53,31 +53,29 @@ function createDocsLayout({ render } = {}) {
 			const renderCtx = { page };
 			for (const r of layoutData.renderers) result = await r.call(renderCtx, result);
 		}
-		return /* @__PURE__ */ jsxs(DocsLayout, {
-			...result.layoutProps,
-			children: [
-				renderPageMeta(page, props),
-				result.layoutProps.children,
-				/* @__PURE__ */ jsxs(DocsPage, {
-					...result.pageProps,
-					children: [
-						result.pageProps.children,
-						/* @__PURE__ */ jsx(DocsTitle, { children: page.data.title }),
-						/* @__PURE__ */ jsx(DocsDescription, {
-							className: "mb-0",
-							children: page.data.description
-						}),
-						/* @__PURE__ */ jsxs("div", {
-							className: "flex flex-row gap-2 items-center border-b pt-2 pb-6",
-							children: [result.markdownUrl && /* @__PURE__ */ jsx(MarkdownCopyButton, { markdownUrl: result.markdownUrl }), /* @__PURE__ */ jsx(ViewOptionsPopover, {
-								markdownUrl: result.markdownUrl,
-								githubUrl: page.absolutePath ? getGitHubFileUrl(props, page.absolutePath) : void 0
-							})]
-						}),
-						/* @__PURE__ */ jsx(DocsBody, { children: result.body })
-					]
-				})
-			]
+		return /* @__PURE__ */ jsxs(TransformChildrenSlot, {
+			Comp: DocsLayout,
+			props: result.layoutProps,
+			children: [renderPageMeta(page, props), /* @__PURE__ */ jsxs(TransformChildrenSlot, {
+				Comp: DocsPage,
+				props: result.pageProps,
+				children: [
+					/* @__PURE__ */ jsx(DocsTitle, { children: page.data.title }),
+					/* @__PURE__ */ jsx(DocsDescription, {
+						className: "mb-0",
+						children: page.data.description
+					}),
+					/* @__PURE__ */ jsxs("div", {
+						className: "flex flex-row gap-2 items-center border-b pt-2 pb-6",
+						children: [result.markdownUrl && /* @__PURE__ */ jsx(MarkdownCopyButton, { markdownUrl: result.markdownUrl }), /* @__PURE__ */ jsx(ViewOptionsPopover, {
+							markdownUrl: result.markdownUrl,
+							githubUrl: page.absolutePath ? getGitHubFileUrl(props, page.absolutePath) : void 0
+						})]
+					}),
+					/* @__PURE__ */ jsx(DocsBody, { children: result.body }),
+					result.lastModified && /* @__PURE__ */ jsx(PageLastUpdate, { date: result.lastModified })
+				]
+			})]
 		});
 	};
 }

package/dist/layouts/home.d.ts

@@ -1,4 +1,4 @@
-import { AppContext } from "../lib/shared.js";
+import { AppContext, TransformChildren } from "../lib/shared.js";
 import { ConfigContext, Layouts } from "../config.js";
 import { Awaitable } from "../lib/types.js";
 import { ReactNode } from "react";
@@ -9,12 +9,12 @@ import { Page } from "fumadocs-core/source";
 interface HomeLayoutOptions<C extends ConfigContext = ConfigContext> {
   render?: (this: AppContext<C>, page: C["loaderConfig"]["page"]) => Awaitable<{
     body?: ReactNode;
-    layoutProps?: Partial<HomeLayoutProps>;
+    layoutProps?: TransformChildren<Partial<HomeLayoutProps>>;
   }>;
 }
 interface HomeLayoutRenderData {
   body: ReactNode;
-  layoutProps: HomeLayoutProps;
+  layoutProps: TransformChildren<HomeLayoutProps>;
 }
 interface HomeLayoutContextData {
   renderers?: ((this: {

package/dist/layouts/home.js

@@ -1,4 +1,4 @@
-import { baseOptions, renderPageMeta } from "../lib/shared.js";
+import { TransformChildrenSlot, baseOptions, renderPageMeta } from "../lib/shared.js";
 import { jsxs } from "react/jsx-runtime";
 import { unstable_notFound } from "waku/router/server";
 import { HomeLayout } from "fumadocs-ui/layouts/home";
@@ -24,8 +24,9 @@ function createHomeLayout({ render }) {
 			const renderCtx = { page };
 			for (const r of layoutData.renderers) result = await r.call(renderCtx, result);
 		}
-		return /* @__PURE__ */ jsxs(HomeLayout, {
-			...result.layoutProps,
+		return /* @__PURE__ */ jsxs(TransformChildrenSlot, {
+			Comp: HomeLayout,
+			props: result.layoutProps,
 			children: [renderPageMeta(page, props), result.body]
 		});
 	};

package/dist/layouts/notebook.d.ts

@@ -0,0 +1,37 @@
+import { AppContext, TransformChildren } from "../lib/shared.js";
+import { ConfigContext, Layouts } from "../config.js";
+import { Awaitable } from "../lib/types.js";
+import { ReactNode } from "react";
+import { DocsLayoutProps } from "fumadocs-ui/layouts/notebook";
+import { DocsPageProps } from "fumadocs-ui/layouts/notebook/page";
+import { Page } from "fumadocs-core/source";
+
+//#region src/layouts/notebook.d.ts
+interface NotebookLayoutOptions<C extends ConfigContext = ConfigContext> {
+  render?: (this: AppContext<C> & {
+    lang?: string;
+  }, page: C["loaderConfig"]["page"]) => Awaitable<{
+    markdownUrl?: string;
+    lastModified?: Date | null;
+    body?: ReactNode;
+    layoutProps?: TransformChildren<Partial<DocsLayoutProps>>;
+    pageProps?: TransformChildren<DocsPageProps>;
+  }>;
+}
+interface NotebookLayoutRenderData {
+  markdownUrl?: string;
+  lastModified?: Date | null;
+  body: ReactNode;
+  layoutProps: TransformChildren<DocsLayoutProps>;
+  pageProps: TransformChildren<DocsPageProps>;
+}
+interface NotebookLayoutContextData {
+  renderers?: ((this: {
+    page: Page;
+  }, data: NotebookLayoutRenderData) => Awaitable<NotebookLayoutRenderData>)[];
+}
+declare function createNotebookLayout<C extends ConfigContext = ConfigContext>({
+  render
+}?: NotebookLayoutOptions<NoInfer<C>>): Layouts<C>["page"];
+//#endregion
+export { NotebookLayoutContextData, NotebookLayoutOptions, NotebookLayoutRenderData, createNotebookLayout };

package/dist/layouts/notebook.js

@@ -0,0 +1,83 @@
+import { TransformChildrenSlot, baseOptions, getGitHubFileUrl, renderPageMeta } from "../lib/shared.js";
+import { jsx, jsxs } from "react/jsx-runtime";
+import { unstable_notFound } from "waku/router/server";
+import { DocsLayout } from "fumadocs-ui/layouts/notebook";
+import { DocsBody, DocsDescription, DocsPage, DocsTitle, MarkdownCopyButton, PageLastUpdate, ViewOptionsPopover } from "fumadocs-ui/layouts/notebook/page";
+//#region src/layouts/notebook.tsx
+function createNotebookLayout({ render } = {}) {
+	async function defaultRender(page) {
+		let body;
+		let toc;
+		for (const adapter of this.adapters) {
+			body = await adapter["core:render-body"]?.call(this, page);
+			if (body !== void 0) break;
+		}
+		for (const adapter of this.adapters) {
+			toc = await adapter["core:render-toc"]?.call(this, page);
+			if (toc !== void 0) break;
+		}
+		if (body === void 0) throw new Error("[Fumapress] Please specify the `render` option in createNotebookLayout()");
+		return {
+			body,
+			pageProps: { toc }
+		};
+	}
+	return async function Layout(props) {
+		const { slugs, lang, getLoader, data: { "core:notebook-layout": layoutData } } = props;
+		const source = await getLoader();
+		const page = source.getPage(slugs, lang);
+		if (!page) unstable_notFound();
+		const _raw = await (render ?? defaultRender).call(props, page);
+		let result;
+		if (_raw.body === void 0 || _raw.pageProps === void 0) {
+			const _default = await defaultRender.call(props, page);
+			result = {
+				markdownUrl: _raw.markdownUrl,
+				pageProps: _raw.pageProps ?? _default.pageProps,
+				body: _raw.body ?? _default.body,
+				layoutProps: {
+					tree: source.getPageTree(lang),
+					..._raw.layoutProps ?? baseOptions(props)
+				}
+			};
+		} else result = {
+			body: _raw.body,
+			pageProps: _raw.pageProps,
+			markdownUrl: _raw.markdownUrl,
+			layoutProps: {
+				tree: source.getPageTree(lang),
+				..._raw.layoutProps ?? baseOptions(props)
+			}
+		};
+		if (layoutData?.renderers) {
+			const renderCtx = { page };
+			for (const r of layoutData.renderers) result = await r.call(renderCtx, result);
+		}
+		return /* @__PURE__ */ jsxs(TransformChildrenSlot, {
+			Comp: DocsLayout,
+			props: result.layoutProps,
+			children: [renderPageMeta(page, props), /* @__PURE__ */ jsxs(TransformChildrenSlot, {
+				Comp: DocsPage,
+				props: result.pageProps,
+				children: [
+					/* @__PURE__ */ jsx(DocsTitle, { children: page.data.title }),
+					/* @__PURE__ */ jsx(DocsDescription, {
+						className: "mb-0",
+						children: page.data.description
+					}),
+					/* @__PURE__ */ jsxs("div", {
+						className: "flex flex-row gap-2 items-center border-b pt-2 pb-6",
+						children: [result.markdownUrl && /* @__PURE__ */ jsx(MarkdownCopyButton, { markdownUrl: result.markdownUrl }), /* @__PURE__ */ jsx(ViewOptionsPopover, {
+							markdownUrl: result.markdownUrl,
+							githubUrl: page.absolutePath ? getGitHubFileUrl(props, page.absolutePath) : void 0
+						})]
+					}),
+					/* @__PURE__ */ jsx(DocsBody, { children: result.body }),
+					result.lastModified && /* @__PURE__ */ jsx(PageLastUpdate, { date: result.lastModified })
+				]
+			})]
+		});
+	};
+}
+//#endregion
+export { createNotebookLayout };

package/dist/layouts/root.d.ts

@@ -3,7 +3,7 @@ import { RootProviderProps } from "fumadocs-ui/provider/waku";
 
 //#region src/layouts/root.d.ts
 interface RootLayoutOptions {
-  providerProps?: RootProviderProps;
+  providerProps?: Omit<RootProviderProps, "children">;
 }
 declare function createRootLayout<C extends ConfigContext = ConfigContext>(options?: RootLayoutOptions): Layouts<C>["root"];
 //#endregion

package/dist/lib/shared.d.ts

@@ -1,8 +1,9 @@
 import { DocsLayoutContextData } from "../layouts/docs.js";
 import { HomeLayoutContextData } from "../layouts/home.js";
+import { NotebookLayoutContextData } from "../layouts/notebook.js";
 import { BuildMode, Config, ConfigContext, I18nConfig } from "../config.js";
 import { Adapter, Awaitable, ServerPlugin } from "./types.js";
-import { ReactNode } from "react";
+import { ComponentType, ReactNode } from "react";
 import { RootProviderProps } from "fumadocs-ui/provider/waku";
 import { LoaderOutput, Page } from "fumadocs-core/source";
 
@@ -33,9 +34,13 @@ interface AppContext<C extends ConfigContext = ConfigContext> {
 }
 interface AppContextData {
   "core:page-meta"?: ((page: Page) => ReactNode)[];
+  "core:notebook-layout"?: NotebookLayoutContextData;
   "core:docs-layout"?: DocsLayoutContextData;
   "core:home-layout"?: HomeLayoutContextData;
   "core:provider"?: ((props: RootProviderProps) => Awaitable<RootProviderProps>)[];
 }
+type TransformChildren<T> = Omit<T, "children"> & {
+  children?: ((nodes: ReactNode) => ReactNode)[];
+};
 //#endregion
-export { AppContext, AppContextData };
+export { AppContext, AppContextData, TransformChildren };

package/dist/lib/shared.js

@@ -59,5 +59,12 @@ function baseOptions(ctx) {
 		githubUrl: git ? `https://github.com/${git.user}/${git.repo}` : void 0
 	};
 }
+function TransformChildrenSlot({ Comp, props, children }) {
+	if (props.children) for (const transformer of props.children) children = transformer(children);
+	return /* @__PURE__ */ jsx(Comp, {
+		...props,
+		children
+	});
+}
 //#endregion
-export { baseOptions, getGitHubFileUrl, parseConfig, renderPageMeta, renderRootMeta };
+export { TransformChildrenSlot, baseOptions, getGitHubFileUrl, parseConfig, renderPageMeta, renderRootMeta };

package/dist/lib/types.d.ts

@@ -30,4 +30,4 @@ type RouteFns = Parameters<Parameters<typeof createPages>[0]>[0] & {
   }) => void;
 };
 //#endregion
-export { Adapter, Awaitable, ServerPlugin };
+export { Adapter, Awaitable, RouteFns, ServerPlugin };

package/dist/vite.js

@@ -12,6 +12,11 @@ function pressCore() {
 				isBuild: command === "build",
 				isFrameworkPkgByName(pkgName) {
 					if (pkgName.startsWith("@fumapress/") || pkgName.startsWith("@fumadocs/") || pkgName.startsWith("fumadocs-") || pkgName.startsWith("fumapress-") || pkgName === "fumapress") return true;
+					switch (pkgName) {
+						case "vite":
+						case "waku":
+						case "shiki": return false;
+					}
 				}
 			});
 			return {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "fumapress",
-  "version": "0.2.4",
+  "version": "0.2.5",
   "description": "An opinionated docs framework powered by Fumadocs",
   "keywords": [
     "Docs",
@@ -22,6 +22,7 @@
     "./adapters/mdx": "./dist/adapters/mdx.js",
     "./layouts/docs": "./dist/layouts/docs.js",
     "./layouts/home": "./dist/layouts/home.js",
+    "./layouts/notebook": "./dist/layouts/notebook.js",
     "./layouts/root": "./dist/layouts/root.js",
     "./plugins/flexsearch": "./dist/plugins/flexsearch.js",
     "./plugins/llms.txt": "./dist/plugins/llms.txt.js",