1 | # Storybook for Svelte
|
2 |
|
3 | Storybook for Svelte is a UI development environment for your Svelte components.
|
4 | With it, you can visualize different states of your UI components and develop them interactively.
|
5 |
|
6 | ![Storybook Screenshot](https://github.com/storybookjs/storybook/blob/main/media/storybook-intro.gif)
|
7 |
|
8 | Storybook runs outside of your app.
|
9 | So you can develop UI components in isolation without worrying about app specific dependencies and requirements.
|
10 |
|
11 | ## Getting Started
|
12 |
|
13 | ```sh
|
14 | cd my-svelte-app
|
15 | npx sb init
|
16 | ```
|
17 |
|
18 | For more information visit: [storybook.js.org](https://storybook.js.org)
|
19 |
|
20 | ---
|
21 |
|
22 | Storybook also comes with a lot of [addons](https://storybook.js.org/docs/svelte/configure/storybook-addons) and a great API to customize as you wish.
|
23 | You can also build a [static version](https://storybook.js.org/docs/svelte/workflows/publish-storybook) of your storybook and deploy it anywhere you want.
|
24 |
|
25 | ## TODOs
|
26 |
|
27 | - [ ] Support `addon-info`
|
28 | - [ ] Support Svelte markup directly in stories
|
29 | - [ ] Add Svelte storybook generator
|
30 | - [ ] Provide stories that show advanced Svelte use cases
|
31 | - [ ] Hydratable
|
32 | - [ ] Advanced mount options
|