MkSaaS Docs
MkSaaS Docs
Homepage

介绍

快速入门什么是 Fumadocs对比

设置

手动安装静态导出

写作

Markdown国际化

UI

概览主题搜索
组件
MDX
提示框
提示框
卡片
卡片
代码块
代码块
标题
标题

MDX

默认 MDX 组件

使用方法

默认的 MDX 组件包括卡片、提示框、代码块和标题。

import defaultMdxComponents from 'fumadocs-ui/mdx';

相对链接

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

import { createRelativeLink } from 'fumadocs-ui/mdx';
import { source } from '@/lib/source';

const page = source.getPage(['...']);

return (
  <MdxContent
    components={{
      // override the `a` tag
      a: createRelativeLink(source, page),
    }}
  />
);
[My Link](./file.mdx)

示例: ../(integrations)/open-graph.mdx

仅限服务器组件。

类型表格

用于记录类型的表格

提示框

在文档中添加提示框

Table of Contents

使用方法
相对链接