LogoMkSaaS文档
    LogoMkSaaS文档
    首页

    介绍

    快速入门什么是 Fumadocs对比

    设置

    手动安装静态导出

    写作

    Markdown国际化

    UI

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

    卡片

    在 MDX 文档中使用卡片组件

    Hello World

    Learn More about Caching and Revalidation

    使用方法

    将其添加到您的 MDX 组件中。

    import { Card, Cards } from 'fumadocs-ui/components/card';
    
    <MDX
      components={{
        Card,
        Cards,
      }}
    />;

    有关用法,请参见 Markdown。

    Cards

    卡片的容器。

    Card

    基于 Next.js 的 <Link />。

    图标的树摇优化

    如果您没有使用 Fumadocs MDX 来渲染 MDX(例如,使用 Contentlayer),请确保 树摇优化正常工作。

    大多数图标库支持单独导入图标。

    import HomeIcon from 'lucide-react/dist/esm/icons/home';

    作为解决方法,您也可以将图标传递给 MDX 组件。(这使用 Next.js 打包器而不是内容源)

    page.tsx
    import { HomeIcon } from 'lucide-react';
    
    const components = {
      ...defaultComponents,
      HomeIcon,
    };

    提示框

    在文档中添加提示框

    代码块

    在文档中添加代码块

    目录

    使用方法
    Cards
    Card