Fumadocs

介绍

核心库入门

这是什么?

Fumadocs Core 提供服务器端函数和 headless 组件,用于在任何 React.js 框架(如 Next.js)上构建文档。

  • 搜索(内置:Orama、Algolia Search)
  • 面包屑、侧边栏、TOC 组件
  • Remark/Rehype 插件
  • 额外实用工具

提示

它可以不使用 Fumadocs UI,换句话说,它是 headless 的。

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

安装

无需其他依赖。

npm install fumadocs-core

对于某些组件,需要框架提供者:

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

export function RootLayout({ children }: { children: ReactNode }) {
  // 或者如果您使用 Fumadocs UI,请使用 `<RootProvider />`
  return <NextProvider>{children}</NextProvider>;
}

它提供简单的文档搜索以及构建优秀文档的组件。

How is this guide?

Last updated on