LogoMkSaaS文档
LogoMkSaaS文档
首页

介绍

快速入门什么是 Fumadocs对比

设置

手动安装静态导出

写作

Markdown国际化

UI

概览主题搜索
组件
MDX
X (Twitter)

概览

Fumadocs UI 的概览

架构

页面树

侧边栏等导航元素使用页面树来渲染导航链接,它是描述所有可用页面和文件夹的树形结构。

通常,它是使用 loader() 从您的文件结构生成的,您可以了解如何组织页面。

自定义

布局

您可以使用不同布局的暴露选项:

文档布局

文档的布局

文档页面

文档内容的布局

笔记本布局

文档布局的更紧凑版本

主页布局

其他页面的布局

组件

Fumadocs UI 还提供了样式化组件,用于交互式示例以增强您的文档,您可以使用暴露的道具如 style 和 className 来自定义它们。

参见组件。

设计系统

由于设计系统是基于 Tailwind CSS 构建的,您可以通过 CSS 变量自定义它。

CLI

如果这些都不适合您,Fumadocs CLI 是一个工具,可以将 Fumadocs UI 组件和布局安装到您的代码库中,类似于 Shadcn UI。允许您完全自定义 Fumadocs UI:

npx fumadocs add

国际化

在您的文档中支持多种语言

主题

为 Fumadocs UI 添加主题

目录

架构
页面树
自定义
布局
组件
设计系统
CLI