applications/storybook/README.md

   1 # Proton Design System Storybook 🤘
   2
   3 This project is a storybook instance documenting Proton's design system in the scope of Web. It serves as both an isolated development environment for React Components as well as a source of centralized documentation all things design philosophy & technical documentation.
   4
   5 ## Installation & Running
   6
   7 Run docs-only in development mode
   8
   9 ```shell
  10 yarn workspace proton-storybook storybook
  11 yarn storybook
  12 ```
  13
  14 The start script defaults to running in docs-only mode (`--docs` flag), however another script called "storybook-raw" has been left (original start script) to run storybook in the original configuration. The storybook docs mention storybook being unable to keep a proper cache in docs-only mode, so the raw command can be used if you're experiencing performance issues while developing locally or just if you'd like to run storybook with a canvas view / for viewing canvas specific addons.
  15
  16 ```shell
  17 yarn workspace proton-storybook storybook-raw
  18 yarn storybook-raw
  19 ```