Skip to content
Get packs

Guide · Open source

How to use Fumadocs: setup, structure and tips

Updated · written with AI from the project's own documentation and checked against our catalogue data

Fumadocs is an open-source framework for building documentation websites with React.js frameworks and Astro. It is meant to be used as a toolkit inside your own project, not as a finished site you configure from a dashboard. This guide explains what it is, which frameworks it supports, how to get the source code, and whether it fits your project so you can decide your next step.

Fumadocsfuma-nama/fumadocs · ★ 13.5k · MIT

Quick start

  1. 1Confirm your stack. Check that you use Next.js, Astro with React, or one of the listed Vite-based frameworks.
  2. 2Confirm ESM support. Make sure your environment can load ESM-only packages, since the README says all packages are ESM only.
  3. 3Clone the repository. Run git clone https://github.com/fuma-nama/fumadocs to get the source code.
  4. 4Read the documentation. Open https://fumadocs.dev to follow the setup and usage guides.
  5. 5Build your docs site. Write your documentation content and React components inside your own project using the framework.

What Fumadocs is and who it is for

Fumadocs is a framework for building documentation websites. You write React code in your own project and use Fumadocs to produce the docs site. It is licensed under MIT and written in TypeScript.

It suits React developers who want to build a docs site, teams already on Next.js or Astro who want their docs in the same stack, and developers who prefer a customizable framework over a hosted service.

  • Good fit: React developers building documentation
  • Good fit: teams already using Next.js or Astro
  • Not a fit: people who need a no-code documentation tool, since it requires writing React code

Choose a supported framework

The README lists these as officially supported: Next.js, Astro (with React), and several Vite-based options: TanStack Start, Waku and React Router.

If your framework is not on this list, the README does not say it works, so check the documentation at fumadocs.dev before committing to it.

  • Next.js
  • Astro (with React)
  • Vite: TanStack Start, Waku, React Router

Get the source code

The README's install method is to clone the repository. Run the following command to download the source:

The README does not list any prerequisites, so after cloning, follow the project's own documentation for building it. The repository also includes a contributing guide at .github/contributing.md if you plan to submit changes.

git clone https://github.com/fuma-nama/fumadocs

Check the ESM-only requirement

The README states that all packages are ESM only. If your environment depends on CommonJS only, Fumadocs is not a match. Check this before you start, because it affects how your project loads packages.

Learn more and get help

The full documentation lives at https://fumadocs.dev. The README links there as the main learning resource. The repository also includes a sticker logo in the documents folder, which the README invites you to print.

What people use it for

  • Building a documentation site for a React library inside a Next.js project
  • Adding a docs section to an Astro site that already uses React components
  • Creating a customizable docs site on a Vite-based framework such as React Router
  • Keeping documentation in the same codebase and stack as the product

Frequently asked questions

Is Fumadocs free to use?

Fumadocs is released under the MIT licence, according to the project's listing. The source is open and you can use it in your own project under those terms. Read the LICENSE file in the repository for the full terms.

What do I need to install Fumadocs?

The README lists no prerequisites. It gives a clone command as the install method, and it says all packages are ESM only. Check the documentation at fumadocs.dev for the setup steps.

Does Fumadocs work with Next.js?

Yes. The README lists Next.js as officially supported, alongside Astro with React and several Vite-based frameworks.

Can I use Fumadocs without writing code?

No. Fumadocs is a framework for React.js and Astro, so you need to write React code to build your docs site. If you want a no-code tool, look for a different product.

Does Fumadocs work with CommonJS?

The README says all packages are ESM only. If your project needs CommonJS only, Fumadocs is not a suitable match.

How does Fumadocs compare to other docs tools?

The source material does not include a comparison with other tools, so this guide cannot make one. Compare the features at fumadocs.dev against your needs, such as your framework and your need for customization.

New agent skills, repos and AI tools — every week

The best new skills and open-source projects, the fastest-growing repos, and one free prompt. Five minutes to read. Unsubscribe anytime.

Our verdict

Fumadocs suits React developers and teams on Next.js, Astro or a listed Vite framework who want a customizable docs site built into their own codebase. It is a poor choice if you want a no-code tool, use a framework outside the officially supported list, or need CommonJS.

Install options & downloads