Skip to content

Commit

Permalink
Update Readme
Browse files Browse the repository at this point in the history
  • Loading branch information
IanVS committed Jan 16, 2023
1 parent 2a30bc5 commit bad14b1
Showing 1 changed file with 21 additions and 17 deletions.
38 changes: 21 additions & 17 deletions packages/builder-vite/README.md
Expand Up @@ -2,9 +2,10 @@

Build your stories with [vite](https://vitejs.dev/) for fast startup times and near-instant HMR.

**Note:** This Repository is for Storybook 6.4 and 6.5. In Storybook 7, the Vite builder was brought into the main Storybook monorepo (https://github.com/storybookjs/storybook). See https://storybook.js.org/blog/first-class-vite-support-in-storybook/ for details.

# Table of Contents <!-- omit in toc -->

- [Migration from storybook-builder-vite](#migration-from-storybook-builder-vite)
- [Installation](#installation)
- [Usage](#usage)
- [Getting started with Vite and Storybook (on a new project)](#getting-started-with-vite-and-storybook-on-a-new-project)
Expand All @@ -15,29 +16,16 @@ Build your stories with [vite](https://vitejs.dev/) for fast startup times and n
- [React Docgen](#react-docgen)
- [Note about working directory](#note-about-working-directory)
- [Known issues](#known-issues)
- [Migration from storybook-builder-vite](#migration-from-storybook-builder-vite)
- [Contributing](#contributing)
- [About this codebase](#about-this-codebase)

## Migration from storybook-builder-vite

This project has moved from `storybook-builder-vite` to `@storybook/builder-vite` as part of a larger effort to improve Vite support in Storybook. To automatically migrate your existing project, you can run

```bash
npx sb@next automigrate
```

To manually migrate:

1. Remove `storybook-builder-vite` from your `package.json` dependencies
2. Install `@storybook/builder-vite`
3. Update your `core.builder` setting in `.storybook/main.js` to `@storybook/builder-vite`.

## Installation

Requirements:

- Vite 4.0 or newer (for Vite v3, use `@storybook/builder-vite@0.2.x`)
- Storybook 6.4.0 or newer (for storybook 6.3, use `storybook-builder-vite@0.1.16`)
- Storybook 6.4 or 6.5 (for storybook 7, see https://github.com/storybookjs/storybook/tree/next/code/lib/builder-vite)

```bash
npm install @storybook/builder-vite --save-dev
Expand Down Expand Up @@ -132,7 +120,9 @@ The function should return the updated Vite configuration.

### Svelte Customization

When using this builder with Svelte, your `.storybook/main.js` (or equivalent)
When using this builder with Svelte, your `svelte.config.js` file will be used automatically.

If you need to make overrides for Storybook, your `.storybook/main.js` (or equivalent)
can contain a `svelteOptions` object to pass custom options to
[`vite-plugin-svelte`](https://github.com/sveltejs/vite-plugin-svelte/tree/main/packages/vite-plugin-svelte):

Expand Down Expand Up @@ -203,6 +193,20 @@ storybook configuration directory. This can be overridden in viteFinal.
- HMR: saving a story file does not hot-module-reload, a full reload happens instead. HMR works correctly when saving component files.
## Migration from storybook-builder-vite
This project has moved from `storybook-builder-vite` to `@storybook/builder-vite` as part of a larger effort to improve Vite support in Storybook. To automatically migrate your existing project, you can run
```bash
npx sb@next automigrate
```
To manually migrate:
1. Remove `storybook-builder-vite` from your `package.json` dependencies
2. Install `@storybook/builder-vite`
3. Update your `core.builder` setting in `.storybook/main.js` to `@storybook/builder-vite`.
## Contributing
The Vite builder cannot build itself.
Expand Down

0 comments on commit bad14b1

Please sign in to comment.