-
-
Notifications
You must be signed in to change notification settings - Fork 9.4k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #20939 from literalpie/qwik-docs
docs: qwik install and troubleshooting instructions
- Loading branch information
Showing
3 changed files
with
28 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,15 @@ | ||
Use the Storybook CLI to install it in a single command. Run this inside your _existing project’s_ root directory: | ||
|
||
- With npm: | ||
|
||
```shell | ||
npx storybook init | ||
``` | ||
|
||
- With pnpm: | ||
|
||
```shell | ||
pnpx storybook init | ||
``` | ||
|
||
If you run into issues with the installation, check the [Troubleshooting section](#troubleshooting) below for guidance on how to solve it. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,11 @@ | ||
- Add the `--type qwik` flag to the installation command to set up Storybook manually: | ||
|
||
```shell | ||
npx storybook init --type qwik | ||
``` | ||
|
||
- Storybook's CLI provides support for [Yarn](https://yarnpkg.com/), [npm](https://www.npmjs.com/), and [pnpm](https://pnpm.io/) package managers. If you have Yarn installed in your environment but prefer to use another as your default package manager add the `--package-manager` flag to your installation command. For example: | ||
|
||
```shell | ||
npx storybook init --package-manager=npm | ||
``` |