Custom MDX GFM Configurator

Utility for custom build pipelines to ensure MDX loader options include GitHub Flavored Markdown support by delegating to the dependency's helper instead of hand-assembling options.

Capabilities

Delegated GFM injection

• When given compile options missing remarkPlugins, returns options that include GitHub Flavored Markdown support by delegating to the dependency's helper @test
• When remarkPlugins already contain entries (including an existing GFM plugin), the returned options preserve them and avoid duplicate GFM entries @test

Preserves compile configuration

• Returned options keep unrelated settings (e.g., providerImportSource, rehypePlugins) identical to input while augmenting remarkPlugins @test

One-time deprecation notice

• The helper emits the dependency's migration warning exactly once across multiple invocations @test

Implementation

@generates

API

export interface MdxCompileOptions {
  remarkPlugins?: unknown[];
  rehypePlugins?: unknown[];
  providerImportSource?: string;
  [key: string]: unknown;
}

/**
 * Applies GitHub Flavored Markdown support to MDX compile options using the dependency's helper
 * while preserving existing plugin lists and other settings.
 */
export function applyGfmToMdxOptions(options: MdxCompileOptions): MdxCompileOptions;

Dependencies { .dependencies }

@storybook/addon-mdx-gfm { .dependency }

Provides a configuration helper to augment MDX loader options with GitHub Flavored Markdown support for Storybook-style MDX pipelines. @satisfied-by