コンテンツへスキップ
Fumadocs

パフォーマンス

Fumadocs MDX のパフォーマンス

概要

Fumadocs MDX はバンドラープラグインです。つまり、パフォーマンスの上限は基盤となるバンドラーに依存しますが、その分ボトルネックに達しにくくなっています。

Turbopack や Vite のような一般的なバンドラーであれば、500 以上の MDX ファイルを含む大規模なドキュメントサイトにも十分対応でき、ほぼすべてのユースケースをカバーできます。

Fumadocs MDX はバンドラーと連携して動作するため、MDX ファイル内でクライアントコンポーネントを含むあらゆるファイルをインポートできます。 これにより高い柔軟性が得られるうえ、デフォルトですべてが最適化されます。

開発サーバー

次の2つのカテゴリーがあります。

  • Lazy: Vite などのバンドラーや、Node.js や Bun などのランタイム側のローダーは、モジュールが要求されたとき (例: await import() が呼び出されたとき) に MDX ファイルをオンデマンドでコンパイルできます。そのため、MDX ファイルの数が開発サーバーのパフォーマンスに大きく影響することはありません。

    ただし、遅延コンパイルを機能させるには、遅延読み込みを有効にしてください。

  • Precompiled: Webpack と Turbopack は開発モードでの遅延コンパイルをサポートしていないため、すべての MDX ファイルを事前にコンパイルしておく必要があります。事前コンパイルする MDX ファイルの数によっては、開発サーバーが遅くなる場合があります。

    これはバンドラー側の制約ですが、速度が気になる場合は代替手段としてローカル Markdown をおすすめします。バンドラー層を経由せず、MDX ファイルをランタイムで読み込んでコンパイルします。詳しくはリンク先の紹介をご覧ください。

画像の最適化

Fumadocs MDX は、Remark Image を使って画像を静的インポートに変換します。 そのため、画像は使用している React フレームワークの仕組み (例: Next.js Image API) によって自動的に最適化されます。

![Hello](./hello.png)

または、public フォルダー内の画像の場合

![Hello](/hello.png)

出力結果:

import HelloImage from './hello.png';

<img alt="Hello" src={HelloImage} />

バナー

本番ビルド

本番ビルドで特に負荷が大きいのは、通常、TypeScript のドキュメント生成 (docgen) (tsgo を使わない場合、TypeScript Compiler は低速です) と、MDX ファイルごとの小さな処理の積み重ねです。

キャッシュがない場合、MDX ファイルが大量にあると、ビルド中のメモリ使用量が極端に増えることがあります。理由は次のとおりです。

  • MDX ファイルを JavaScript にコンパイルした後、バンドラーは出力された JavaScript ファイルもバンドルする必要があります。
  • 各 MDX ファイルのコンパイル時間はわずかでも、合計すると長くなることがあります。たとえば、約 2500 ファイルで 1 ファイルあたり 25ms かかるとすると、コールドビルドには最大 62.5 秒かかります。

主な解決策は、コンパイルをオンデマンドにして、リクエストされたときにだけコンテンツを読み込むようにすることです。

ローカル Markdown

開発サーバーのセクションで紹介したとおり、ローカル Markdown は追加のコンパイル処理なしに完全にランタイムで動作するため、有力な代替手段となります。

リモートソース

リモートでコンテンツを読み込む独自のコンテンツソースを作成できます。

コンテンツソースでコンテンツファイルを事前にコンパイルする必要がなければ、SSG でオンデマンドに処理できるため、ビルド速度を向上させられます。 ただし、ビルド時の最適化 (バンドルなど) は利用できません。

独自ソースの実装方法については、Custom Source を参照してください。

How is this guide?