Skip to content

Commit

Permalink
Merge pull request #25988 from turtle601/docs/yarn-pnp-create-nodemod…
Browse files Browse the repository at this point in the history
…ules-message

Docs: add message that storybook creates node_modules in pnp
  • Loading branch information
jonniebigodes authored Feb 22, 2024
2 parents 7270f01 + 6c7e5d5 commit b1b530f
Showing 1 changed file with 4 additions and 0 deletions.
4 changes: 4 additions & 0 deletions docs/get-started/install.md
Original file line number Diff line number Diff line change
Expand Up @@ -132,6 +132,10 @@ If you're working with a custom environment set up or need set up Storybook manu

<!-- prettier-ignore-end -->

#### Yarn Plug'n'Play (PnP) support with Storybook

If you've enabled Storybook in a project running on a new version of Yarn with [Plug'n'Play](https://yarnpkg.com/features/pnp) (PnP) enabled, you may notice that it will generate `node_modules` with some additional files and folders. This is a known constraint as Storybook relies on some directories (e.g., `.cache`) to store cache files and other data to improve performance and faster builds. You can safely ignore these files and folders, adjusting your `.gitignore` file to exclude them from the version control you're using.

#### Run Storybook with Webpack 4

If you previously installed Storybook in a project that uses Webpack 4, it will no longer work. This is because Storybook now uses Webpack 5 by default. To solve this issue, we recommend you upgrade your project to Webpack 5 and then run the following command to migrate your project to the latest version of Storybook:
Expand Down

0 comments on commit b1b530f

Please sign in to comment.