Fumadocs

Running Locally

Install, develop, build, and preview the Fumadocs sample with Bun.

Requirements

  • Bun 1.3.14 or later

All package, Next.js, Fumadocs, TypeScript, and preview commands run with the Bun runtime. No second JavaScript runtime is required.

Install

cd frameworks/fumadocs
bun install

The postinstall script generates the typed .source/ content collection. CI may disable lifecycle scripts with --ignore-scripts; bun run types:check and bun run build each generate that collection explicitly as well.

Develop

bun run dev

Open http://localhost:3000/docfw-cmp/fumadocs/en/ or the Japanese /ja/ route. The base path is enabled in development as well as production.

Build and preview

bun run build
bun run preview

The static build is written to out/. The preview server exposes it at http://localhost:3000/docfw-cmp/fumadocs/ with Bun's native HTTP server and the same base path used by GitHub Pages. The repository-level preview additionally assembles the hub and all framework samples.

On this page