Fumadocs

介绍

入门核心库

这是什么?

🌐 What is this?

Fumadocs Core 提供服务器端功能和无头组件,可在任何 React.js 框架(如 Next.js)上构建文档。

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

  • 搜索(内置:Orama、Algolia 搜索)
  • 面包屑、侧边栏、目录组件
  • Remark/Rehype 插件
  • 附加实用工具

提示

它可以在没有 Fumadocs 用户界面的情况下使用,换句话说,它是无头的。

对于初学者和普通使用,请使用 Fumadocs UI

安装

🌐 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.

Last updated on

On this page