Fumadocs

Static Build

Output static website with Fumadocs.

Setup

By default, Fumadocs use a server-first approach which always requires a running server to serve.

You can output a static build by configuring your framework.

  1. Configure Search Server.
  2. Configure Search UI/Client.

After the configurations, your app will statically store the search indexes, and search will be computed on browser instead.

Cloud Solutions

Since the search functionality is powered by remote servers, static export works without configuration.

Deployment

You can enable Next.js static export, it allows you to export the app as a static HTML site without a Node.js server.

next.config.mjs
/**
 * @type {import('next').NextConfig}
 */
const nextConfig = {
  output: 'export',

  // Optional: Change links `/me` -> `/me/` and emit `/me.html` -> `/me/index.html`
  // trailingSlash: true,

  // Optional: Prevent automatic `/me` -> `/me/`, instead preserve `href`
  // skipTrailingSlashRedirect: true,
};

See Next.js docs for limitations and details.

How is this guide?

Last updated on