Storybook Docs GFM Preset

Configure Storybook docs MDX pages so GitHub Flavored Markdown features render correctly while keeping existing compile options intact.

Capabilities

Renders GFM markdown

• A docs MDX page containing a markdown table renders the table structure in the rendered story docs. @test
• A docs MDX page containing task list items renders checkboxes that reflect the markdown state. @test

Keeps existing MDX options

• When existing MDX compile options already include custom remark plugins, enabling GFM keeps those entries intact and appends the support needed for tables and task lists. @test

Warns about transitional preset

• Loading the preset issues a single deprecation warning through the provided logger to guide migration to direct configuration. @test

Manual hook usable outside Storybook

• The exported helper can be invoked directly on an MDX loader configuration to add GFM support in non-Storybook build steps. @test

Implementation

@generates

API

/**
 * Applies GitHub Flavored Markdown support to a docs MDX configuration.
 * Must preserve existing compile options while ensuring GFM features are enabled.
 */
export function applyGfmPreset(mdxOptions, logger);

/**
 * Preset object consumed by Storybook to apply the same GFM configuration.
 */
export const docsPreset: {
  configureMdx(options);
};

Dependencies { .dependencies }

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

Provides Storybook docs integration that enables GitHub Flavored Markdown in MDX files.