Fumadocs

Introduction

Getting started with core library

What is this?

Fumadocs Core offers server-side functions and headless components to build docs on React.js frameworks like Next.js, Waku, and Astro with React islands.

Tip

It can be used without Fumadocs UI, in other words, it's headless.

For beginners and normal usages, use Fumadocs UI.

Installation

Install the core package. Individual integrations may require additional dependencies, listed in their guides.

npm install fumadocs-core

For some components, a framework provider is needed:

import type { ReactNode } from 'react';
import { NextProvider } from 'fumadocs-core/framework/next';

export function RootLayout({ children }: { children: ReactNode }) {
  // or if you're using Fumadocs UI, use `<RootProvider />`
  return <NextProvider>{children}</NextProvider>;
}

Explore the APIs and components:

How is this guide?

Last updated on

On this page