Support for .md / .mdx files in storybook

[nate-summercook]

Support for .md / .mdx files in storybook

[fi3ework]

storybook-rsbuild's configuration is a little complex so for now you had to write the rsbuildFinal in the following style

import { mergeRsbuildConfig } from '@rsbuild/core'
import type { StorybookConfig } from 'storybook-react-rsbuild'
import { join, dirname } from 'path'

/**
 * This function is used to resolve the absolute path of a package.
 * It is needed in projects that use Yarn PnP or are set up within a monorepo.
 */
function getAbsolutePath(value: string): any {
  return dirname(require.resolve(join(value, 'package.json')))
}

const config: StorybookConfig = {
  stories: ['../src/**/*.mdx', '../src/**/*.stories.@(js|jsx|mjs|ts|tsx)'],
  addons: [
    getAbsolutePath('@storybook/addon-onboarding'),
    getAbsolutePath('@storybook/addon-links'),
    getAbsolutePath('@storybook/addon-essentials'),
    getAbsolutePath('@chromatic-com/storybook'),
    getAbsolutePath('@storybook/addon-interactions'),
  ],
  framework: {
    name: getAbsolutePath('storybook-react-rsbuild'),
    options: {},
  },
  docs: {
    autodocs: 'tag',
  },
  typescript: {
    reactDocgen: 'react-docgen',
    check: true,
  },
  rsbuildFinal: (config) => {
    return mergeRsbuildConfig(config, {
      tools: {
+       rspack(config, { addRules, mergeConfig }) {
+         return mergeConfig(config, {
+             module: {
+              rules: [
+               {
+                test: /\.md$/,
+                type: 'asset/source',
+             },
+              ],
+           },
          })
        },
      },
    })
  },
}

export default config

[fi3ework]

With above configuration, the .md could be rendered as plain text instead of Markdown style. Is that identical with webpack?

[nate-summercook]

Well, I'm importing it plain text to render it within an .mdx file. So that should work. Can't test it though until #30 is addressed ;) Unless I'd set up a separate project just to test this.

[fi3ework]

So when importing and using a .md in .mdx, the .md file could be render as Markdown content with webpack & SB8?

[nate-summercook]

webpack & SB7, yes. But the import was *.md?raw but I think that results in pretty much the same.

[fi3ework]

I'll test does it works on webpack and SB8 then align with it.