MDX GFM Hook

Enables GitHub Flavored Markdown support for MDX loader configurations without disturbing existing remark/rehype plugin chains.

Capabilities

Non-destructive merge

• Returns a new options object when provided existing remarkPlugins so callers keep their original references. @test
• Appends GitHub Flavored Markdown support after any existing remark plugins while leaving rehypePlugins untouched. @test

Duplicate avoidance

• When GitHub Flavored Markdown support is already present anywhere in remarkPlugins, returns options without adding another entry. @test

Warning behavior

• Emits a migration warning the first time the hook runs, and suppresses further warnings on subsequent calls. @test

Safe defaults

• If remarkPlugins is missing, initializes it with GitHub Flavored Markdown support while preserving all other loader options. @test

Implementation

@generates

API

/**
 * Accepts MDX loader options and returns an options object with GitHub Flavored Markdown enabled.
 * Must not mutate the provided input.
 */
export function applyGfmSupport(options);

/**
 * Preset export for build systems that auto-discover hooks.
 * Exposes the applyGfmSupport behavior to the host environment.
 */
export const preset;

Dependencies { .dependencies }

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

Provides GitHub Flavored Markdown support for Storybook MDX loaders and presets.