Fumadocs

Introduction

Getting started with core library

What is this?

Fumadocs Core offers server-side functions and headless components, built for App Router.

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

Tip

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

For beginners and normal usages, use Fumadocs UI.

Installation

No other dependencies required.

npm install fumadocs-core

It offers simple document searching as well as components for building a good docs. It is made for flexibility and speed.

Breadcrumb

The navigation component at the top of screen

TOC

A Table of Contents with active anchor observer

Sidebar

The navigation bar at aside of viewport

Search

Implement document searching

Edit on GitHub

Last updated on

Next

Internationalization

On this page