Storybook GFM Deprecation Helper

A helper that integrates the official MDX GFM migration addon while surfacing its deprecation guidance.

Capabilities

Surface migration warning

• Running the helper logs the addon's deprecation message, including migration guidance and link to configuring remark-gfm directly. @test

Emit warning once

• Invoking the helper multiple times in one process produces the warning only once. @test

Apply addon MDX config

• The helper delegates MDX loader configuration to the addon dependency and returns the config with GitHub Flavored Markdown enabled while preserving existing remark plugins. @test

Implementation

@generates

API

export interface MdxLoaderConfig {
  mdxCompileOptions?: {
    remarkPlugins?: any[];
    [key: string]: any;
  };
  [key: string]: any;
}

/**
 * Ensures the official GFM migration addon runs so its deprecation warning is surfaced and MDX config is patched.
 * @param config Existing MDX loader config object.
 * @param log Logger invoked with the warning text when emitted; defaults to console.warn when omitted.
 * @returns The MDX config returned by the addon after applying GFM support.
 */
export function applyGfmMigrationAddon(
  config: MdxLoaderConfig,
  log?: (message: string) => void
): Promise<MdxLoaderConfig>;

Dependencies { .dependencies }

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

Provides the migration helper that patches MDX loader options and emits a deprecation warning guiding users to configure remark-gfm directly.