Fumadocs

组件

用于改进文档的额外组件

概述

您可以使用以下额外组件:

MDX 组件

默认 MDX 组件包括 Cards、Callouts、代码块和标题。

import defaultMdxComponents from 'fumadocs-ui/mdx';

相对链接

仅限服务器组件。

要支持 href 中的相对文件路径链接,请使用以下方式覆盖默认 a 组件:

app/docs/[[...slug]]/page.tsx
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)

示例:../../feedback.mdx

How is this guide?

Last updated on