Fumadocs

What Fumadocs is

Fumadocs is an open-source React.js framework for developers building documentation sites with customizable content and presentation. It supports Markdown and MDX natively and can connect to content sources such as a CMS. Official installation templates are available for Next.js, Astro with React, Waku, React Router, and Tanstack Start. Authors can use syntax highlighting, code groups, callouts, cards, custom heading anchors, and an automatic table of contents. Developers can adjust the default theme or use headless mode to provide their own UI. Search can use the built-in ZBSearch engine or connect to Algolia, FlexSearch, Meilisearch, Mixedbread, Orama Cloud, or Typesense. Its OpenAPI integration can present endpoint details, an interactive playground, request examples, response samples, and TypeScript definitions. Fumadocs can serve processed Markdown pages and generated llms.txt files for LLMs and AI agents. Applications deploy through the chosen underlying React framework, and static builds for CDN hosting are documented. Fumadocs is free and community powered. The maker says it does not work on the Edge runtime, and directs people with questions or confusing documentation to GitHub Discussions. It also supports private documentation and documentation versioning.

Who it suits

Fumadocs suits developers creating product, project, or API documentation with React frameworks. It is also aimed at teams building UI component libraries, with interactive component playgrounds highlighted by the maker.

Limits

Fumadocs is free and open source, with no paid plan listed. The maker says it does not work on the Edge runtime.

Getting started

1. Visit the Fumadocs website.
2. Choose an official installation template for Next.js, Astro with React, Waku, React Router, or Tanstack Start.
3. Add Markdown or MDX content, or connect a content source such as a CMS.
4. Customize the default theme or use headless mode for your own UI.
5. Deploy through the underlying React framework or use a documented static build for CDN hosting.
6. Use GitHub Discussions for questions or feedback.

Verdict

Choose Fumadocs if you want a free, open-source framework for customizable documentation and are comfortable deploying through a React framework. Look elsewhere if your deployment depends on the Edge runtime.