Quick Start

IntroductionCopy Anchor Link

Fumadocs (Foo-ma docs) is a documentation framework, designed to be fast, flexible, and composes seamlessly into your React framework. It consists of multiple layers:

TerminologyCopy Anchor Link

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

Bun: A JavaScript runtime, it will be used in our guides for running scripts. If you prefer Node.js, try unrun instead.

Some basic knowledge of React.js would be useful for further customizations.

Automatic InstallationCopy Anchor Link

A minimum version of Node.js 22 required.

npm create fumadocs-app

It will ask you the built-in template to use:

• Framework: Next.js, React Router, TanStack Start, Waku and Astro.
• Content source: Fumadocs MDX, or Astro content collections.

A new fumadocs app should be initialized, with following features configured by default:

• LLM integration.
• Dynamic metadata image.

Enjoy!Copy Anchor Link

Create your first MDX file in the docs folder.

---
title: Hello World
---

## Yo what's up

Run the app in development mode:

npm run dev

Open http://localhost:3000/docs to see your page.

FAQCopy Anchor Link

Some common questions you may encounter.

pnpm update -i -r --latest

import { loader } from 'fumadocs-core/source';

export const source = loader({
  baseUrl: '/info', // to the new value
});

import { defineConfig } from 'vite';

export default defineConfig({
  resolve: {
    // add other Fumadocs deps as needed
    noExternal: ['fumadocs-core', 'fumadocs-ui', 'fumadocs-openapi', '@fumadocs/base-ui'],
  },
});

Learn MoreCopy Anchor Link

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 ContentCopy Anchor Link

For authoring docs, make sure to read:

Special NeedsCopy Anchor Link