Quick Start

Introduction

Fumadocs (Foo-ma docs) is a documentation framework based on Next.js, designed to be fast, flexible, and composes seamlessly into Next.js App Router.

Fumadocs has different parts:

Terminology

Markdown/MDX: Markdown is a markup language for creating formatted text. Fumadocs supports Markdown and MDX (superset of Markdown) out-of-the-box.

Although not required, some basic knowledge of Next.js App Router would be useful for further customisations.

Automatic Installation

A minimum version of Node.js 18 required, note that Node.js 23.1 might have problems with Next.js production build.

npm create fumadocs-app

pnpm create fumadocs-app

yarn create fumadocs-app

bun create fumadocs-app

It will ask you the framework and content source to use, a new fumadocs app should be initialized. Now you can start hacking!

Enjoy!

Create your first MDX file in the docs folder.

---
title: Hello World
---

## Yo what's up

Run the app in development mode and see http://localhost:3000/docs.

npm run dev

Explore

In the project, you can see:

• lib/source.ts: Code for content source adapter, loader() provides an interface to interact with your content source, and assigns URL to your pages.
• app/layout.config.tsx: Shared options for layouts, optional but preferred to keep.

Writing Content

For authoring docs, make sure to read:

Content Source

Content source handles all your content, like compiling Markdown files and validating frontmatter.

Customise UI

See Customisation Guide.

FAQ

Some common questions you may encounter.

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!