コンポーネント
ドキュメントを充実させるための追加コンポーネント
概要
そのほかに利用できるコンポーネントは以下のとおりです。
アコーディオン
ドキュメントにアコーディオンを追加します
自動型テーブル
自動生成される型テーブル
バナー
サイトにバナーを追加します
コードブロック
Shiki でハイライトされたコードブロックを表示します
コードブロック(動的)
コードのハイライトも行うコードブロック
Files
ドキュメント内にファイル構造を表示します
GitHub 情報
GitHub リポジトリの情報を表示します
グラフビュー
すべてのページをグラフで表示します。
ズーム可能な画像
ドキュメント内の画像をズームできるようにします
インライン目次
ドキュメントにインライン目次を追加します
Steps
ドキュメントにステップを追加する
Tabs
Base UI で構築された Tabs コンポーネントです。値の永続化や共有値などの機能も備えています。
型テーブル
型の情報をドキュメントに記載するためのテーブル
MDX コンポーネント
デフォルトの MDX コンポーネントには、Cards、Callouts、Code Blocks、Headings などがあります。
import defaultMdxComponents from 'fumadocs-ui/mdx';相対リンク
サーバーコンポーネントでのみ使用できます。
href に相対ファイルパスを指定したリンクをサポートするには、デフォルトの a コンポーネントを次のようにオーバーライドします。
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 と同様にレンダリングを行います。
<Content components={{ a: createRelativeLink(source, page) }} />[My Link](./file.mdx)How is this guide?
最終更新日
