Skip to content

Commit

Permalink
Merge pull request #20185 from storybookjs/chore_docs_fix_svelte_nati…
Browse files Browse the repository at this point in the history
…ve_troubleshooting

Chore: (Docs) Adjusts the installation issues docs for the new framework matrix
  • Loading branch information
jonniebigodes committed Dec 9, 2022
2 parents e745299 + e303928 commit b505c26
Show file tree
Hide file tree
Showing 8 changed files with 30 additions and 10 deletions.
2 changes: 1 addition & 1 deletion docs/get-started/installation-problems/angular.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -42,4 +42,4 @@
| `"styles"` | Provide the location of the [application's styles](../configure/styling-and-css.md#importing-css-files) to be used with Storybook. <br/> `"styles": ["src/styles.css", "src/styles.scss"]` <br/> |
| `"stylePreprocessorOptions"` | Provides further customization for style preprocessors resolved to the workspace root. <br/> `"stylePreprocessorOptions": { "includePaths": ["src/styles"] }` |

- For other installation issues, check the [Angular README](../../app/angular/README.md) for additional instructions.
- For other installation issues, check the [Angular README](https://github.com/storybookjs/storybook/tree/next/code/frameworks/angular) for additional instructions.
2 changes: 1 addition & 1 deletion docs/get-started/installation-problems/ember.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -20,4 +20,4 @@ Update the [`@storybook/ember-cli-storybook`](https://www.npmjs.com/package/@sto
npx storybook init --package-manager=npm
```

- For other installation issues, check the [Ember README](../../app/ember/README.md) for additional instructions.
- For other installation issues, check the [Ember README](https://github.com/storybookjs/storybook/tree/next/code/frameworks/ember) for additional instructions.
4 changes: 3 additions & 1 deletion docs/get-started/installation-problems/html.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,6 @@
npx storybook init --type html
```

- For other installation issues, check the [Html README](../../app/html/README.md) for additional instructions.
- For other installation issues, check the React README files for additional instructions:
- [HTML with Webpack]( https://github.com/storybookjs/storybook/tree/next/code/frameworks/html-webpack5)
- [HTML with Vite](https://github.com/storybookjs/storybook/tree/next/code/frameworks/html-vite)
2 changes: 1 addition & 1 deletion docs/get-started/installation-problems/preact.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -10,4 +10,4 @@
npx storybook init --package-manager=npm
```

- For other installation issues, check the [Preact README](../../app/preact/README.md) for additional instructions.
- For other installation issues, check the [Preact README](https://github.com/storybookjs/storybook/tree/next/code/frameworks/preact-webpack5) for additional instructions.
6 changes: 4 additions & 2 deletions docs/get-started/installation-problems/react.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,8 @@
npx storybook@next automigrate
```

Check the [Migration Guide](https://github.com/storybookjs/storybook/blob/next/MIGRATION.md#cra5-upgrade) for more information on how to set up Webpack 5.
Check the [Migration Guide](https://github.com/storybookjs/storybook/blob/next/MIGRATION.md#cra5-upgrade) for more information on how to set up Webpack 5.

- For other installation issues, check the [React README](../../app/react/README.md) for additional instructions.
- For other installation issues, check the React README files for additional instructions:
- [React with Webpack](https://github.com/storybookjs/storybook/tree/next/code/frameworks/react-webpack5)
- [React with Vite](https://github.com/storybookjs/storybook/tree/next/code/frameworks/react-vite)
13 changes: 12 additions & 1 deletion docs/get-started/installation-problems/svelte.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -10,5 +10,16 @@
npx storybook init --package-manager=npm
```

### Svelte Native

To enable support for Svelte Native story format you'll need to make the following changes your Storybook configuration:
- Add the [`@storybook/addon-svelte-csf`](https://storybook.js.org/addons/@storybook/addon-svelte-csf/) addon as development dependency.
- Enable the addon in your Storybook configuration file (e.g., `.storybook/main.js`).
- Disable on demand story loading configuration property (e.g., `storyStoreV7`) in your Storybook configuration file.
- For issues with Svelte Native Story Format, check the [Svelte Story Format addon repository](https://github.com/storybookjs/addon-svelte-csf) for instructions.
- For other installation issues, check the [Svelte README](../../app/svelte/README.md) for additional instructions.


- For other installation issues, check the Svelte README files for additional instructions:
- [Svelte with Webpack](https://github.com/storybookjs/storybook/tree/next/code/frameworks/svelte-webpack5)
- [Svelte with Vite](https://github.com/storybookjs/storybook/tree/next/code/frameworks/svelte-vite)
- [SvelteKit](https://github.com/storybookjs/storybook/tree/next/code/frameworks/sveltekit)
7 changes: 5 additions & 2 deletions docs/get-started/installation-problems/vue.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -14,5 +14,8 @@
npx storybook init --package-manager=npm
```

- For other installation issues, check the [Vue 2 README](../../app/vue/README.md), or the [Vue 3 README](../../app/vue3/README.md) for additional instructions.
- Vue 3 support is under active development, and we encourage feedback and improvements. Check the [contribution guidelines to help us improve it](../../CONTRIBUTING.md).
- For other installation issues, check the Vue README files for additional instructions:
- [Vue 2 with Webpack](https://github.com/storybookjs/storybook/tree/next/code/frameworks/vue-webpack5)
- [Vue 2 with Vite](https://github.com/storybookjs/storybook/tree/next/code/frameworks/vue-vite)
- [Vue 3 with Webpack](https://github.com/storybookjs/storybook/tree/next/code/frameworks/vue3-webpack5)
- [Vue 3 with Vite](https://github.com/storybookjs/storybook/tree/next/code/frameworks/vue3-vite)
4 changes: 3 additions & 1 deletion docs/get-started/installation-problems/web-components.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,6 @@
npx storybook init --type web_components
```

- For other installation issues, check the [Web Components README](../../app/web-components/README.md) for additional instructions.
- For other installation issues, check the Web Components README files for additional instructions:
- [Web Components with Webpack](https://github.com/storybookjs/storybook/tree/next/code/frameworks/web-components-webpack5)
- [Web Components with Vite](https://github.com/storybookjs/storybook/tree/next/code/frameworks/web-components-vite)

0 comments on commit b505c26

Please sign in to comment.