コンテンツへスキップ
Fumadocs

コンポーネント

ドキュメントを充実させるための追加コンポーネント

概要

そのほかに利用できるコンポーネントは以下のとおりです。

MDX コンポーネント

デフォルトの MDX コンポーネントには、Cards、Callouts、Code Blocks、Headings などがあります。

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 '@/components/mdx';

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

return (
  <MdxContent
    components={getMDXComponents({
      // `a` タグをオーバーライド
      a: createRelativeLink(source, page),
    })}
  />
);

Astro では、これを <Content /> に渡します。<Content /> は Astro の MDX と同様にレンダリングを行います。

src/pages/docs/[...slug].astro
<Content components={{ a: createRelativeLink(source, page) }} />
[My Link](./file.mdx)

例: ../../(integrations)/feedback.mdx

How is this guide?

最終更新日