グローバルオプション

すべてのコレクションに適用される MDX プラグインなど、Fumadocs MDX のグローバルオプションは、プロジェクトルートの source.config.ts に記述します。このファイルは省略可能で、lib/source.ts で Macro API を使って定義したコレクションでも機能します。

グローバルオプション

source.config.ts

import { defineConfig } from 'fumadocs-mdx/config';

export default defineConfig({
  // グローバルオプション
});

プロパティ

型

MDX オプション

コレクションのデフォルトプリセットをカスタマイズします。mdxOptions は unified でコンパイルされるコレクションに、satteriOptions は compiler: 'satteri' を指定したコレクションに適用されます。

source.config.ts

import { defineConfig } from 'fumadocs-mdx/config';
import { myPlugin } from './remark-plugin';

export default defineConfig({
  mdxOptions: {
    // 順序が重要な場合
    remarkPlugins: (v) => [myPlugin, ...v],
  },
});

または、minimal プリセットを使用する場合は次のとおりです。

source.config.ts

import { defineConfig } from 'fumadocs-mdx/config';

export default defineConfig({
  mdxOptions: {
    preset: 'minimal',
    // この場合、MDX プロセッサーのオプションのみを受け付けます
  },
});

グローバルオプション

グローバルオプションアンカーリンクをコピー

MDX オプションアンカーリンクをコピー

このページの内容

グローバルオプション

MDX オプション