Skip to Content
Fumadocs

Static Build

Output static website with Fumadocs.

Setup

By default, Fumadocs uses a server-first approach, which requires a running server. You can output a static build by configuring TanStack Start.

  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

Configure SPA mode and pre-rendering. See SPA Mode for details.

vite.config.ts
import { tanstackStart } from '@tanstack/react-start/plugin/vite';
import { defineConfig } from 'vite';

export default defineConfig({
  plugins: [
    // ...other plugins
    tanstackStart({
      spa: {
        enabled: true,
        // TanStack Router will automatically crawl your pages
        prerender: {
          enabled: true,
        },
        // if you have any hidden paths that's not visible on UI, you can add them explicitly.
        pages: [
          {
            path: '/docs/test',
          },
        ],
      },
    }),
  ],
});

How is this guide?

Last updated on