Quick Start
Getting Started with Fumadocs
Introduction
Fumadocs (Foo-ma docs) is a documentation framework, designed to be fast, flexible, and composes seamlessly into your React framework.
Fumadocs has different parts:
Fumadocs Core
Handles most of the logic, including document search, content source adapters, and Markdown extensions.
Fumadocs UI
The default theme of Fumadocs offers a beautiful look for documentation sites and interactive components.
Content Source
The source of your content, can be a CMS or local data layers like Fumadocs MDX (the official content source).
Fumadocs CLI
A command line tool to install UI components and automate things, useful for customizing layouts.
Want to learn more?
Read our in-depth What is Fumadocs introduction.
Terminology
Markdown/MDX: Markdown is a markup language for creating formatted text. Fumadocs natively supports Markdown and MDX (superset of Markdown).
Bun: A JavaScript runtime, we use it for running scripts.
Some basic knowledge of React.js would be useful for further customisations.
Automatic Installation
A minimum version of Node.js 20 required.
npm create fumadocs-appIt will ask you the built-in template to use:
- React.js framework: Next.js, Waku, React Router, Tanstack Start.
- Content source: Fumadocs MDX.
A new fumadocs app should be initialized. Now you can start hacking!
From Existing Codebase?
You can follow the Manual Installation guide to get started.
Enjoy!
Create your first MDX file in the docs folder.
---
title: Hello World
---
## Yo what's upRun the app in development mode and see http://localhost:3000/docs.
npm run devFAQ
Some common questions you may encounter.
For Vite
For Next.js
Learn More
New to here? Don't worry, we are welcome for your questions.
If you find anything confusing, please give your feedback on Github Discussion!
Writing Content
For authoring docs, make sure to read:
Markdown
Fumadocs has some additional features for authoring content.
Navigation
Learn how to customise navigation links and sidebar items.
Page Slugs & Page Tree
Learn how to organise content.
Components
See all available components to enhance your docs
Special Needs
How is this guide?
Last updated on