Minor tweaks to the install section

This commit is contained in:
jonniebigodes 2022-01-04 21:27:53 +00:00
parent 5f460ece27
commit 06539c6a46
13 changed files with 113 additions and 34 deletions

View File

@ -72,7 +72,7 @@ There are some noteworthy items here:
<details>
<summary><h4 id="troubleshooting">Troubleshooting</h4></summary>
Below is a curated list to get you unblocked while adding Storybook to your project.
Below are some of the most common installation issues and instructions on how to solve them.
<!-- prettier-ignore-start -->
@ -99,4 +99,4 @@ If all else fails, try asking for [help](https://storybook.js.org/support)
</details>
Now that you installed Storybook successfully, lets take a look at a story that was written for us.
Now that you installed Storybook successfully, lets take a look at a story that was written for us.

View File

@ -1,3 +1,17 @@
- You can also setup Storybook manually through the Storybook CLI. Add the `--type angular` flag when you initialize Storybook in your project.
- If there's an installation problem, check the [README for the Angular framework](../../app/angular/README.md).
- Check if you're running the install command in the root directory of your project, or if you're working with a monorepo from the directory where the `angular.json` is located.
- Add the `--type angular` flag to the installation command to set up Storybook manually:
```shell
npx sb init --type angular
```
- Storybook supports Webpack 5 out of the box. If you're upgrading from a previous version, run the following command to enable it:
```shell
npx sb@next automigrate
```
Check the [Migration Guide](https://github.com/storybookjs/storybook/blob/next/MIGRATION.md#automigrate) for more information on how to set up Webpack 5.
- When adding Storybook to your Angular project, check if you're running the install command from the root directory. Or in a monorepo environment inside the directory where the `angular.json` file is located.
- For other installation issues, check the [Angular README](../../app/angular/README.md) for additional instructions.

View File

@ -1,14 +1,17 @@
- You can also setup Storybook manually through the Storybook CLI. Add the `--type ember` flag when you initialize Storybook in your project.
- Add the `--type ember` flag to the installation command to set up Storybook manually:
- If you see the following message during the `@storybook/ember-cli-storybook` installation process:
```shell
npx sb init --type ember
```
```shell
The ember generate entity-name command requires an entity name to be specified.
- During the install process, if you get the following warning message:
For more details, use ember help.
```
```shell
The ember generate entity-name command requires an entity name to be specified.
This is just a warning! If you followed the instructions provided, everything should be properly configured.
For more details, use ember help.
```
Update the [`@storybook/ember-cli-storybook`](https://www.npmjs.com/package/@storybook/ember-cli-storybook) package to the latest version to fix it.
- If you run into a installation problem, check the [README for the Ember framework](../../app/ember/README.md) for additional instructions.
- For other installation issues, check the [Ember README](../../app/ember/README.md) for additional instructions.

View File

@ -1,2 +1,7 @@
- You can also setup Storybook manually through the Storybook CLI. Add the `--type html` flag when you initialize Storybook in your project.
- If there's an installation problem, check the [README for the Html framework](../../app/html/README.md).
- Add the `--type html` flag to the installation command to set up Storybook manually:
```shell
npx sb init --type html
```
- For other installation issues, check the [Html README](../../app/html/README.md) for additional instructions.

View File

@ -1,2 +1,7 @@
- You can also setup Storybook manually through the Storybook CLI. Add the `--type marko` flag when you initialize Storybook in your project.
- If there's an installation problem, check the [README for the Marko framework](https://github.com/storybookjs/marko).
- Add the `--type marko` flag to the installation command to set up Storybook manually:
```shell
npx sb init --type marko
```
- For other installation issues, check the [Marko repository](https://github.com/storybookjs/marko) for additional instructions.

View File

@ -1,2 +1,7 @@
- You can also setup Storybook manually through the Storybook CLI. Add the `--type mithril` flag when you initialize Storybook in your project.
- If there's an installation problem, check the [README for the Mithril framework](https://github.com/storybookjs/mithril).
- Add the `--type mithril` flag to the installation command to set up Storybook manually:
```shell
npx sb init --type mithril
```
- For other installation issues, check the [Mithril repository](https://github.com/storybookjs/mithril) for additional instructions.

View File

@ -1,2 +1,7 @@
- You can also setup Storybook manually through the Storybook CLI. Add the `--type preact` flag when you initialize Storybook in your project.
- If there's an installation problem, check the [README for the Preact framework](../../app/preact/README.md).
- Add the `--type preact` flag to the installation command to set up Storybook manually:
```shell
npx sb init --type preact
```
- For other installation issues, check the [Preact README](../../app/preact/README.md) for additional instructions.

View File

@ -1,2 +1,7 @@
- You can also setup Storybook manually through the Storybook CLI. Add the `--type rax` flag when you initialize Storybook in your project.
- If there's an installation problem, check the [README for the Rax framework](https://github.com/storybookjs/rax).
- Add the `--type rax` flag to the installation command to set up Storybook manually:
```shell
npx sb init --type rax
```
- For other installation issues, check the [Rax repository](https://github.com/storybookjs/rax) for additional instructions.

View File

@ -1,2 +1,15 @@
- You can also setup Storybook manually through the Storybook CLI. Add the `--type react` flag when you initialize Storybook in your project.
- If there's an installation problem, check the [README for the React framework](../../app/react/README.md).
- Add the `--type react` flag to the installation command to set up Storybook manually:
```shell
npx sb init --type react
```
- Storybook supports Webpack 5 out of the box. If you're upgrading from a previous version, run the following command to enable it:
```shell
npx sb@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.
- For other installation issues, check the [React README](../../app/react/README.md) for additional instructions.

View File

@ -1,2 +1,7 @@
- You can also setup Storybook manually through the Storybook CLI. Add the `--type riot` flag when you initialize Storybook in your project.
- If there's an installation problem, check the [README for the Riot framework](https://github.com/storybookjs/riot/).
- Add the `--type riot` flag to the installation command to set up Storybook manually:
```shell
npx sb init --type riot
```
- For other installation issues, check the [Riot repository](https://github.com/storybookjs/riot/) for additional instructions.

View File

@ -1,3 +1,8 @@
- You can also setup Storybook manually through the Storybook CLI. Add the `--type svelte` flag when you initialize Storybook in your project.
- If there's an installation problem, check the [README for the Svelte framework](../../app/svelte/README.md).
- If there's an installation problem with Svelte Native Story Format, check the [README for the Svelte Story Format](https://github.com/storybookjs/addon-svelte-csf).
- Add the `--type svelte` flag to the installation command to set up Storybook manually:
```shell
npx sb init --type svelte
```
- 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.

View File

@ -1,3 +1,12 @@
- You can also set up Storybook manually through the Storybook CLI. Add the `--type vue` flag when you initialize Storybook in your Vue 2 project, or `--type vue3` for Vue 3 based projects.
- If you run into a installation problem, check the [README for the Vue 2 framework](../../app/vue/README.md) or [Readme for the Vue 3](../../app/vue3/README.md) for additional instructions.
- Add the `--type vue` (for Vue 2), or `--type vue3` (for Vue 3) flag to the installation command to set up Storybook manually:
```shell
# For Vue 2 projects
npx sb init --type vue
# For Vue 3 projects
npx sb init --type vue3
```
- 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).

View File

@ -1,2 +1,7 @@
- You can also setup Storybook manually through the Storybook CLI. Add the `--type web_components` flag when you initialize Storybook in your project. web_components
- If there's an installation problem, check the [README for the Web Components framework](../../app/web-components/README.md).
- Add the `--type web_components` flag to the installation command to set up Storybook manually:
```shell
npx sb init --type web_components
```
- For other installation issues, check the [Web Components README](../../app/web-components/README.md) for additional instructions.