Fumadocs

The beautiful & flexible React.js docs framework.

  • Other
  • Tools & Utilities
  • Web & Publishing
The beautiful & flexible React.js docs framework.

Platform availability

Available on 1 of 10 platforms

  • Unraid (not listed)
  • TrueNAS (not listed)
  • Umbrel (not listed)
  • ZimaOS (not listed)
  • Proxmox
  • Helm (not listed)
  • Mac (not listed)
  • Windows (not listed)
  • Linux (not listed)
  • Any server (not listed)

Health score?A 0-100 score computed nightly from four factors: maintained (40%: recent commits and steady activity), popular (25%: GitHub stars, log scale), easy to install (20%: platforms, install notes, setup guides, Docker image) and light to run (15%: minimum RAM, ARM support). When the source code has been checked, a fifth factor, security check (20%: automated scan for committed secrets, unsafe desktop-app settings, known-vulnerable dependencies and project hygiene; any serious finding caps it at 20), is added. Factors without data are left out and the rest are rescaled.

76/100 Good

Maintained
100last commit 5 days ago
Popular
8313,640 GitHub stars
Easy to install
251 install platform, install notes
Light to run
No data
Security check
70no serious findings, 5 minor, CI, tests

Based on 4 of 5 factors.

Availability: platform listings confirmed today, links checked 12 days ago

GitHub stars
13,640
Open issues
2
Last commit
2026-11-16
Latest release
[email protected]
License
MIT
Activity
steady

Checked 5 days ago - source: GitHub (fuma-nama/fumadocs)

Resources & Compatibility

Requirements not published yet.

First-install notes

  • Install the Fumadocs packages first Run the npm install command to add fumadocs-core and fumadocs-ui to your project. Without these packages, the docs layout and page components won't exist. source
  • Add a sample docs page Create content/docs/index.mdx with a simple title and text. This gives the docs system a real page to build, so your site isn't empty or broken on first run. source
  • Install Satteri only if using it Add @fumadocs/satteri if your setup uses the Satteri workflow. It is optional, but skipping it when you need it will leave that feature unavailable. source

Fetched 53 days ago - each note links to its source

Alternatives

No alternatives collected yet.

Common questions

Will Fumadocs work in a CommonJS setup?

No, all Fumadocs packages are ESM only.

What packages are required for a manual Fumadocs installation?

Install fumadocs-core and fumadocs-ui first; without these packages, the docs layout and page components won't exist.

Is @fumadocs/satteri required for the MDX setup?

Only if your setup uses the Satteri workflow. It is optional, but skipping it when you need it will leave that feature unavailable.

Is there a guide for customizing the Fumadocs UI?

Yes, the guides section includes a complete guide on how to customize the Fumadocs UI.

Answers sourced from github.com, www.fumadocs.dev, www.fumadocs.dev, www.fumadocs.dev

Community

Collected 48 days ago - public community threads