组件
用于改进文档的额外组件
概述
您可以使用以下额外组件:
Accordion
将折叠面板添加到您的文档中
自动类型表格
自动生成的类型表格
横幅
为您的站点添加横幅
代码块
显示 Shiki 高亮的代码块
代码块(动态)
一个也高亮代码的代码块
文件
在文档中显示文件结构
GitHub 信息
显示您的 GitHub 仓库信息
图形视图
所有页面的图形。
可缩放图像
允许在文档中缩放图像
内联 TOC
将内联 TOC 添加到您的文档中
步骤
向文档添加步骤
选项卡
基于 Radix UI 构建的选项卡组件,附加功能包括持久化和共享值。
类型表
一个用于文档化类型的表格
MDX 组件
默认 MDX 组件包括 Cards、Callouts、代码块和标题。
import defaultMdxComponents from 'fumadocs-ui/mdx';相对链接
仅限服务器组件。
要支持 href 中的相对文件路径链接,请使用以下方式覆盖默认 a 组件:
import { createRelativeLink } from 'fumadocs-ui/mdx';
import { source } from '@/lib/source';
import { getMDXComponents } from '@/mdx-components';
const page = source.getPage(['...']);
return (
<MdxContent
components={getMDXComponents({
// override the `a` tag
a: createRelativeLink(source, page),
})}
/>
);[My Link](./file.mdx)How is this guide?
Last updated on
