Fumadocs logo

Fumadocs

Build beautiful documentation websites with React.js frameworks

A flexible React.js framework for building documentation sites with official support for Next.js, Vite, TanStack Start, Waku, and React Router.

Fumadocs banner

Overview

Modern Documentation Framework for React

Fumadocs is a TypeScript-first framework designed to help developers build polished, production-ready documentation websites using their preferred React.js stack. With official support for Next.js, Vite, TanStack Start, Waku, and React Router, teams can integrate documentation into existing projects or spin up standalone sites without vendor lock-in.

Built for Flexibility and Developer Experience

The framework embraces modern web standards with ESM-only packages and leverages MDX for content authoring, enabling rich interactive documentation with React components. Styled with Tailwind CSS and powered by TypeScript, Fumadocs provides type-safe APIs and customizable theming out of the box. Whether you're documenting an open-source library, building internal wikis, or creating API portals, the framework adapts to your workflow.

Production-Ready and Community-Driven

With over 8,500 GitHub stars and active maintenance, Fumadocs has proven itself in real-world deployments. The MIT license ensures commercial-friendly usage, while comprehensive documentation at fumadocs.dev guides teams from setup to deployment. The framework's modular architecture lets you adopt only what you need, keeping bundle sizes lean and build times fast.

Highlights

Multi-framework support: Next.js, Vite, TanStack Start, Waku, React Router
MDX-powered content authoring with React component integration
TypeScript-first with type-safe APIs and ESM-only architecture
Tailwind CSS styling with customizable theming system

Pros

  • Framework-agnostic design works with multiple React.js ecosystems
  • Strong TypeScript support ensures type safety across documentation projects
  • Active community with 8,500+ stars and zero open issues
  • MIT license allows unrestricted commercial and private use

Considerations

  • ESM-only packages may require build configuration updates for legacy projects
  • Requires familiarity with React.js and chosen framework ecosystem
  • MDX learning curve for teams accustomed to plain Markdown
  • Limited to React.js; not suitable for Vue, Svelte, or vanilla JavaScript projects

Managed products teams compare with

When teams consider Fumadocs, these hosted platforms usually appear on the same shortlist.

Mintlify logo

Mintlify

Docs automation and analytics for engineering teams

Looking for a hosted option? These are the services engineering teams benchmark against before choosing open source.

Fit guide

Great for

  • Teams already using Next.js, Vite, or modern React.js frameworks
  • Projects requiring interactive documentation with embedded React components
  • Developers seeking type-safe documentation tooling with TypeScript
  • Organizations needing flexible, self-hosted documentation solutions

Not ideal when

  • Projects requiring CommonJS module support or legacy build systems
  • Teams without React.js experience or infrastructure
  • Simple static sites where Markdown-only generators suffice
  • Multi-framework documentation needing Vue or Angular examples

How teams use it

Open-Source Library Documentation

Ship interactive API references with live code examples embedded directly in documentation pages using React components.

Internal Developer Portals

Centralize engineering guides, runbooks, and API specs with type-safe search and navigation tailored to your tech stack.

Product Documentation Sites

Build customer-facing help centers with custom branding, versioned content, and seamless integration into existing Next.js applications.

Technical Blog with Code Playgrounds

Publish tutorials featuring interactive demos and syntax-highlighted code blocks powered by MDX and React.

Tech snapshot

TypeScript75%
MDX21%
CSS2%
JavaScript1%
Python1%
Shell1%

Tags

docsnextcontentlayerreact-routerapp-routerfumadocstanstack-routernextjscontent-collectionstailwindcssmdxtypescript

Frequently asked questions

Which React frameworks does Fumadocs support?

Fumadocs officially supports Next.js, Vite, TanStack Start, Waku, and React Router, allowing you to choose the framework that fits your project.

Can I use Fumadocs with CommonJS projects?

No, all Fumadocs packages are ESM-only. You'll need to configure your build system to support ECMAScript modules.

Does Fumadocs require TypeScript?

While Fumadocs is TypeScript-first and provides full type safety, you can use it with JavaScript projects, though you'll miss out on type-checking benefits.

What content format does Fumadocs use?

Fumadocs uses MDX, which combines Markdown syntax with the ability to import and render React components directly in your documentation.

Is Fumadocs free for commercial use?

Yes, Fumadocs is released under the MIT license, permitting unrestricted use in commercial, private, and open-source projects.

Project at a glance

Active
Stars
10,375
Watchers
10,375
Forks
578
LicenseMIT
Repo age2 years old
Last commit2 days ago
Self-hostingSupported
Primary languageTypeScript

Last synced 2 days ago