Skip to content

Commit

Permalink
Merge pull request #102 from storybookjs/mdx-warning
Browse files Browse the repository at this point in the history
Document limitation for .mdx stories
  • Loading branch information
yannbf authored Apr 28, 2022
2 parents 5aafae7 + 5ccece6 commit b17bb51
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -147,7 +147,7 @@ yarn test-storybook --url https://the-storybook-url-here.com

By default, the test runner transforms your story files into tests. It also supports a secondary "stories.json mode" which runs directly against your Storybook's `stories.json`, a static index of all the stories.

This is particularly useful for running against a deployed storybook because `stories.json` is guaranteed to be in sync with the Storybook you are testing. In the default, story file-based mode, your local story files may be out of sync--or you might not even have access to the source code.
This is particularly useful for running against a deployed storybook because `stories.json` is guaranteed to be in sync with the Storybook you are testing. In the default, story file-based mode, your local story files may be out of sync--or you might not even have access to the source code. Furthermore, it is not possible to run the test-runner directly against `.mdx` stories, and stories.json mode must be used.

To run in stories.json mode, first make sure your Storybook has a v3 `stories.json` file. You can navigate to:

Expand Down

0 comments on commit b17bb51

Please sign in to comment.