# Fumadocs

Fumadocs is a self-hosted other app. The beautiful & flexible React.js docs framework. It is open source and self-hosted, installable on Proxmox.

Canonical page: https://ourlocalhost.com/app/3772/fumadocs

## Description

The beautiful & flexible React.js docs framework.

## Platform availability

Available on 1 of 10 platforms: Proxmox.

## Health score

76/100 (Good), based on 4 of 5 factors.
- Maintained: 100 (last commit 5 days ago)
- Popular: 83 (13,640 GitHub stars)
- Easy to install: 25 (1 install platform, install notes)
- Security check: 70 (no serious findings, 5 minor, CI, tests)

## Links

- Proxmox: https://community-scripts.github.io/ProxmoxVE/scripts?id=fumadocs
- GitHub: https://github.com/fuma-nama/fumadocs
- Official website: https://fumadocs.dev

## 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.

---
Source: Our Local Host (https://ourlocalhost.com/app/3772/fumadocs), the self-hosted and open-source app directory.
