Manual Installation

You can also let Fumadocs CLI set it up for you:

npx @fumadocs/cli init

PrerequisitesCopy Anchor Link

Before continuing, make sure you have configured:

• Next.js 16.
• Tailwind CSS 4.

This guide uses Fumadocs MDX as the content source. Configure it first:

npm i fumadocs-mdx fumadocs-core @types/mdx

import { createMDX } from 'fumadocs-mdx/next';

/** @type {import('next').NextConfig} */
const config = {
  reactStrictMode: true,
};

const withMDX = createMDX();

export default withMDX(config);

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

const docs = defineDocs({
  dir: 'content/docs',
});

export const source = loader({
  baseUrl: '/docs',
  source: docs.toFumadocsSource(),
});

Getting StartedCopy Anchor Link

Install the packages:

npm i fumadocs-core fumadocs-ui

StylesCopy Anchor Link

Add the following to your Tailwind CSS file:

@import 'tailwindcss';
@import 'fumadocs-ui/css/neutral.css';
@import 'fumadocs-ui/css/preset.css';

Root ProviderCopy Anchor Link

Wrap your entire app inside Root Provider, and add the required styles to body.

import { RootProvider } from 'fumadocs-ui/provider/next';
import type { ReactNode } from 'react';

export default function Layout({ children }: { children: ReactNode }) {
  return (
    <html lang="en" suppressHydrationWarning>
      <body
        // required styles
        className="flex flex-col min-h-screen"
      >
        <RootProvider>{children}</RootProvider>
      </body>
    </html>
  );
}

RoutesCopy Anchor Link

Put the shared options of your layouts in one file:

import type { BaseLayoutProps } from 'fumadocs-ui/layouts/shared';

export function baseOptions(): BaseLayoutProps {
  return {
    nav: {
      title: 'My App',
    },
  };
}

Create the following files:

import defaultMdxComponents from 'fumadocs-ui/mdx';
import type { MDXComponents } from 'mdx/types';

export function getMDXComponents(components?: MDXComponents) {
  return {
    ...defaultMdxComponents,
    ...components,
  } satisfies MDXComponents;
}

export const useMDXComponents = getMDXComponents;

declare global {
  type MDXProvidedComponents = ReturnType<typeof getMDXComponents>;
}

The search route uses ZBSearch. See Document Search to configure it.

FinishCopy Anchor Link

Start the dev server and write your docs in content/docs:

---
title: Hello World
---

## Introduction

I love Fumadocs.