toMedia

介绍

Fumadocs Core — 文档站点的无头核心库

Fumadocs Core 是一个无头库,提供文档站点所需的服务端函数和 React 组件。它可跨多个 React 框架使用,包括 Next.js、React Router、Tanstack Router 和 Waku。

核心功能

搜索功能

支持 Orama 和 Algolia 等搜索引擎

导航组件

Breadcrumb 和 Sidebar

目录组件

带有活动锚点观察器的 Table of Contents

Remark/Rehype 插件

Markdown 处理插件

工具函数

各种实用工具

安装

npm install fumadocs-core

无需额外依赖。

框架 Provider

不同框架有对应的 Provider:

  • NextProvider — Next.js 应用
  • ReactRouterProvider — React Router
  • TanstackProvider — Tanstack Start/Router
  • WakuProvider — Waku

关键组件与功能

  1. Breadcrumb — 屏幕顶部的导航组件
  2. TOC — 带有活动锚点观察器的目录
  3. Source API — 处理内容源的统一接口
  4. Search — 文档搜索功能

该库强调"无头"特性,可独立于 Fumadocs UI 运行。对于初学者,建议使用 Fumadocs UI 作为典型用例。

On this page