fumadocs
The beautiful & flexible React.js docs framework.
A React framework for building documentation websites with Next.js or Vite, letting you write docs in Markdown and embed interactive components without assembling the structure from scratch.
Fumadocs is a framework for building documentation websites with React.js. It provides the structure and tools needed to create a well-organized technical documentation site, so developers do not have to assemble the pieces from scratch. The project describes itself as both beautiful in design and flexible enough to adapt to different project setups.
The framework officially supports Next.js and three Vite-based React frameworks: Tanstack Start, Waku, and React Router. It is built around MDX, a file format that combines standard Markdown text (the kind of simple formatting used in README files) with the ability to embed interactive React components. This makes it possible to include live code examples, interactive diagrams, or custom UI elements inside documentation pages.
All packages in the repository use the ESM module format. This is a technical constraint that means the framework requires a modern JavaScript toolchain and does not work in environments that only support the older CommonJS format.
The repository README is short and points readers to the project documentation site at fumadocs.dev for detailed setup instructions, configuration options, and examples. The project topics also reference content collections, which is an approach to organizing large sets of documentation files with structured metadata, though no further detail is given in the README.
Contributions to the project are accepted through pull requests, and a contributing guide is available in the repository.
Where it fits
- Build a well-structured documentation site for your library using Next.js and MDX without writing navigation and layout code from scratch.
- Embed interactive React components like live code playgrounds or custom diagrams directly inside Markdown documentation pages.
- Organize large documentation sets with structured metadata using content collections for easy navigation and search.