Card

Use the Card component in your MDX documentation

Usage

Add it to your MDX components.

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

See Markdown for usages.

Cards

The container of cards.

Card

Based on Next.js <Link />.

PropTypeDefault
icon
ReactNode
-
description
ReactNode
-
href
string
-
external
boolean
-

Tree Shaking on icons

If you're not using Fumadocs MDX for rendering MDX (e.g. using Contentlayer), ensure that tree shaking is working properly.

Most of the icon libraries support importing icons individually.

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

As a workaround, you can pass icons to MDX Components too. (this uses Next.js bundler instead of content source)

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

Last updated on

On this page