mirror of
https://github.com/storybookjs/storybook.git
synced 2025-04-06 15:31:16 +08:00
43 lines
2.2 KiB
Markdown
43 lines
2.2 KiB
Markdown
# Storybook for Svelte
|
|
|
|
[](https://circleci.com/gh/storybooks/storybook)
|
|
[](https://www.codefactor.io/repository/github/storybooks/storybook)
|
|
[](https://snyk.io/test/github/storybooks/storybook/8f36abfd6697e58cd76df3526b52e4b9dc894847)
|
|
[](https://bettercodehub.com/results/storybooks/storybook) [](https://codecov.io/gh/storybooks/storybook)
|
|
[](https://now-examples-slackin-rrirkqohko.now.sh/)
|
|
[](#backers) [](#sponsors)
|
|
|
|
* * *
|
|
|
|
Storybook for Svelte is a UI development environment for your Svelte components.
|
|
With it, you can visualize different states of your UI components and develop them interactively.
|
|
|
|
|
|
|
|
Storybook runs outside of your app.
|
|
So you can develop UI components in isolation without worrying about app specific dependencies and requirements.
|
|
|
|
## Getting Started
|
|
|
|
```sh
|
|
npm i -g @storybook/cli
|
|
cd my-svelte-app
|
|
getstorybook
|
|
```
|
|
|
|
For more information visit: [storybook.js.org](https://storybook.js.org)
|
|
|
|
* * *
|
|
|
|
Storybook also comes with a lot of [addons](https://storybook.js.org/addons/introduction) and a great API to customize as you wish.
|
|
You can also build a [static version](https://storybook.js.org/basics/exporting-storybook) of your storybook and deploy it anywhere you want.
|
|
|
|
## TODOs
|
|
|
|
- [ ] Support `addon-info`
|
|
- [ ] Support Svelte markup directly in stories
|
|
- [ ] Add Svelte storybook generator
|
|
- [ ] Provide stories that show advanced Svelte use cases
|
|
- [ ] Hydratable
|
|
- [ ] Advanced mount options
|