Fumadocs

A framework for building documentation websites using MDX and React with support for multiple web frameworks.

Fumadocs screenshot 1

Fumadocs is an open-source web app and server framework for building documentation websites. It enables the creation of knowledge bases using MDX and is designed to integrate with various React-based environments. The software operates as a server-side web application framework for developers who need to manage technical documentation and public-facing guides.

The tool supports multiple deployment targets and frameworks to ensure flexibility in the development stack. While it is primarily associated with Next.js, it also officially supports Vite-based environments including Tanstack Start, Waku, and React Router. It utilizes a component-based approach to structure content and navigation, allowing developers to maintain a consistent look and feel across large sets of technical documents.

Key features

  • Support for MDX content files
  • Integration with Next.js App Router
  • Compatibility with Vite and Tanstack Start
  • Support for Waku and React Router
  • Built-in search functionality
  • Customizable UI components
  • ESM-only package architecture
  • Support for content collections

The framework is built using TypeScript and Tailwind CSS, focusing on a developer-centric workflow for content management. It allows for the organization of documentation through content collections, which provides a structured way to handle metadata and page hierarchies. This architecture is designed for technical writers and software engineers who prefer to keep their documentation in version control alongside their source code, ensuring that updates to the software and its guides happen in tandem.

By leveraging the React ecosystem, the framework allows for the inclusion of interactive components directly within the documentation pages. This makes it suitable for projects that require more than static text, such as API references with live examples or interactive tutorials. The use of ESM-only packages ensures compatibility with modern JavaScript modules and build tools used in contemporary web development.

Fumadocs is a flexible foundation for React developers to build structured, searchable documentation sites.

Last Modified
Software TypeWeb App / Server
Platform
Last Activity16 days ago
Repository Age3 years
LicenseMIT
Open Source Alternative to
Open Source Software.io

Join our newsletter to get shiny new open source software delivered to your inbox. Unsubscribe anytime.