LogoMkSaaS Docs
LogoMkSaaS Docs
Homepage

Introduction

Quick StartWhat is FumadocsComparisons

Setup

Manual InstallationStatic Export

Writing

MarkdownInternationalization

UI

OverviewThemesSearch
Components
MDX
X (Twitter)

Quick Start

Getting Started with Fumadocs

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:

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 Content Collections and 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 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

It will ask you the framework and content source to use, 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.

content/docs/index.mdx
---
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.
RouteDescription
app/(home)The route group for your landing page and other pages.
app/docsThe documentation layout and pages.
app/api/search/route.tsThe Route Handler for search.

Writing Content

For authoring docs, make sure to read:

Markdown

Fumadocs has some additional features for authoring content too.

Navigation

Learn how to customise navigation links/sidebar items.

Content Source

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

Read the Introduction to learn how it handles your content.

A source.config.ts config file has been included, you can customise different options like frontmatter schema.

Fumadocs is not Markdown-exclusive. For other sources like Sanity, you can build a custom content source.

Customise UI

See Customisation Guide.

FAQ

Some common questions you may encounter.

Video Tutorials

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!

Configure Static Export

Learn how to enable static export on your docs

Customise Search

Learn how to customise document search

Theming

Add themes to Fumadocs UI

Components

See all available components to enhance your docs

What is Fumadocs

Introducing Fumadocs, a docs framework that you can break.

Table of Contents

Introduction
Terminology
Automatic Installation
Enjoy!
Explore
Writing Content
Content Source
Customise UI
FAQ
Video Tutorials
Learn More
fumadocs-app