Fumapress 2

Fumapress 2Copy Anchor Link

• This release has breaking changes, follow the migration guide.

Changed the site config to createPress()Copy Anchor Link

• press.config exports createPress(content, options).plugins(...).config({...}), replacing defineConfig(), .adapters() and .layouts().
• Removed loaderOptions: its fields are options of createPress(), and loaderPlugins replaces loaderOptions.plugins.
• .config() is optional: createPress(content).plugins(...) is a complete site.
• ui.renderPage(props) renders every page, content pages and plugin views, typed by props.type. props.renderDefault() is the built-in UI: layout picks a Fumadocs layout, and layoutProps and pageProps are typed by it.
• A custom layout reads props.layoutProps, props.pageData, props.toc, props.body and props.slots.
• Removed the layout factories of fumapress/layouts/*, use renderDefault({ layout }) or the Fumadocs UI layouts directly in ui.renderPage. selectTreeRoot(tree, "docs") of fumapress replaces their treeRoot option.
• ui.renderRoot replaces renderRoot and also receives the styles as head. ui.layoutProps replaces defaultLayoutProps, ui.translations replaces translations, and the head tags replace meta.
• ui.providerProps sets the root provider of every page, like theme or a custom search.SearchDialog.
• Removed renderNotFound. The 404 page is a custom src/pages/404.tsx, else a plugin view at /404, else the built-in page in the Home Layout.
• preset takes a list: preset: [] replaces preset: false. recommendedPreset({ rss: false }) drops one default plugin, recommendedPreset({ sitemap: { path: "/map.xml" } }) passes it options.
• The MDX renderer is built in: press({ components: "./src/components/mdx.tsx" }) of fumapress/vite replaces fumadocsMdx() of fumapress/adapters/mdx.
• RenderPageProps<typeof app>, UIOptions<typeof app>, WakuRouteProps<typeof app, "/showcase/[slug]"> and getPressContext<typeof app>() type custom files, replacing $context and .utils(). WakuRouteConfig replaces RouteConfig.
• Fumapress needs the Base UI build of Fumadocs UI, fumadocs-ui@npm:@fumadocs/base-ui. The Radix UI build is no longer supported.
• Update fumadocs-core and fumadocs-ui to 16.18.2 or later, and fumadocs-mdx to 15.5.1 or later.

Changed rendering to be per routeCopy Anchor Link

• mode of createPress() replaces the mode option, for one source or per source key. auto prerenders static sources and renders dynamic ones on demand, force-dynamic renders content on demand, and force-static prerenders a dynamic source loaded at build.
• Removed this.mode and BuildMode. Plugins read this.getContentRender(source?) instead.
• By default, pages of dynamic content sources render on demand, pages of static sources are prerendered, and one site can mix both.
• Pages rendered on demand from a dynamic source with staleTime, and their .md file and OG image, get Cache-Control: public, s-maxage=<staleTime in seconds>.
• The .md file and OG image of a page follow its route. The sitemap, RSS, llms.txt and llms-full.txt are prerendered unless a content source is dynamic.
• Custom pages default to render: "static" and custom API routes to render: "dynamic". A static API route sets render: "static" in getConfig(), and can set staticPaths.
• flexsearchPlugin() and oramaSearchPlugin() follow the content source: static sources export an index at /api/search.json, dynamic sources search on the server. render overrides it.
• A site deploys as static files when no route renders on demand and no plugin has middleware. On a platform, the static option of Waku in a server entry leaves out the function of the adapter.
• A build without a server warns that the middleware of plugins never runs, naming the plugins.

Changed the plugin APICopy Anchor Link

• Plugins are Plugin of fumapress, replacing PressPlugin, and extend the framework plugins of fumadocs-core/framework/plugin. PressContext<typeof app> replaces AppContext.
• Hooks: routes({ createApi, createView }), deriveRoutes(), middleware(), head(), slots(), layoutProps(), providerProps(), configureLoader(), transformPage(), getPageView() and build().
• middleware() runs first on every request of the server, the prerendered pages and static files of a Node.js server included. Files a platform serves never reach it.
• The waku hooks createPages, honoMiddleware and unstable_serverEntry replace createPages, createMiddlewares and unstable_onServerEntry. Plugin layouts live in route groups only.
• To replace a default plugin, set it to false in recommendedPreset() and list your plugin.
• layoutProps() of plugins sets the props of every layout, like sidebar, tabs and aiChat.
• useLayoutProps() of fumapress/client and @fumapress/astro/client returns the layout props that plugins give from client state, like the AI chat: spread it into a custom layout. The built-in UI applies them.
• Slot items have a unique name and a region: actions, footer, toc-header, toc-footer, sidebar-banner, sidebar-footer, banner, body-wrapper or layout-wrapper. The built-in UI places them, and ui.renderPage receives them by name in props.slots.
• The built-in page buttons are the slot items core:markdown and core:view-options.
• PageData is the data of every page. getConfig() of custom pages and createView() take data, like the title and description of the page in <head>. Plugins read it with this.getPageData().
• For components per page, list the renderer, like mdxPlugin() of fumadocs-mdx/press, with components as a function of the page.
• Removed preinit, configureRoutes, plugin renderPage, this.data and Adapter.
• fumapress exports the types that plugins use, like Context, HeadTag, SlotItem and PageData.

Removed packages and entriesCopy Anchor Link

• Removed fumapress/plugins/openapi, fumapress/plugins/asyncapi, @fumapress/graphql, @fumapress/notion, @fumapress/sanity and @fumapress/obsidian. Use the default export of fumadocs-openapi/press, @fumadocs/asyncapi/press, @fumadocs/graphql/press, @fumadocs/notion/press, @fumadocs/sanity/press and fumadocs-obsidian/press.
• Removed fumapress/plugins/blog and fumapress/layouts/blog*, use @fumapress/blog. fumapress/css/preset.css leaves out the blog styles, import @fumapress/blog/css/preset.css with it.
• Removed fumapress/adapters/mdx/schema. pageSchema and metaSchema are in fumapress/schema, blogPageSchema in @fumapress/blog/schema.
• Removed fumapress/i18n, the translations of plugins are added for you.

Changed imagesCopy Anchor Link

• vercelImage(), cloudflareImage() and selfHostedImage() replace imagePlugin() of fumapress/plugins/image/*. The preset picks the platform's.
• selfHostedImage() needs a server and site.baseUrl, without them images stay as they are. vercelImage() and cloudflareImage() work with static output.
• data.ogImage in getConfig() replaces takumiOptions, and takumiPlugin() takes path and getImage instead of basePath and generate.
• On Cloudflare Workers, Open Graph images use the WebAssembly build of Takumi without passing it yourself.

FixesCopy Anchor Link

• A basePath works on Cloudflare, which needs Wrangler 4.148 or later, and on Netlify. Its root opened without a trailing slash hydrates on every host.
• llms.txt and the Markdown of pages link full page URLs, with the base path.
• The browser fetches the page tree once, instead of receiving it with every page. Change its lists in pageTree.transformers of the loader, not in ui.renderPage.
• On a Node.js server, .md files are served as text/markdown and Accept: text/markdown also serves the Markdown of prerendered pages.
• Markdown negotiation works on URLs with a trailing slash.
• The robots.txt sitemap link follows the sitemap path of recommendedPreset(), and sitemaps escape & in alternate links.
• Without a home page, the navbar title goes to the first page of the language, and so does / with i18n.
• When pages render on demand, a language root like /cn renders its page instead of a 404.

Fixed client state between pagesCopy Anchor Link

• Client state of a page, like selected code tabs, no longer carries over to the next page. Tabs of the next page could show no content.

Secured requestsCopy Anchor Link

• Other spellings of a URL path, like //docs, /%64ocs, /docs/ or /docs/index.html, redirect to the normal path, so middleware sees the path the router matches.
• Middleware sees the page URL on every client navigation, whatever the request method.
• The self-hosted image optimizer fetches relative images from site.baseUrl, never from the Host of a request, and limits its memory.
• The route of llmsPlugin({ routes: "all" }) that renders Markdown is unreachable from outside.
• A fully dynamic source no longer writes its page tree to the public directory.