Introduction

What is this?

Fumadocs Core offers server-side functions and headless components to build docs on any React.js frameworks like Next.js.

• Search (built-in: Orama, Algolia Search)
• Breadcrumb, Sidebar, TOC Components
• Remark/Rehype Plugins
• Additional utilities

Installation

No other dependencies required.

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>;
}

It offers simple document searching as well as components for building a good docs.