Skip to content

Commit

Permalink
Merge pull request #20939 from literalpie/qwik-docs
Browse files Browse the repository at this point in the history
docs: qwik install and troubleshooting instructions
  • Loading branch information
jonniebigodes authored Feb 8, 2023
2 parents 742f878 + 1f76bea commit 34b4920
Show file tree
Hide file tree
Showing 3 changed files with 28 additions and 0 deletions.
2 changes: 2 additions & 0 deletions docs/get-started/install.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ title: 'Install Storybook'
'get-started/installation-command-section/svelte.mdx',
'get-started/installation-command-section/vue.mdx',
'get-started/installation-command-section/web-components.mdx',
'get-started/installation-command-section/qwik.mdx',
]}
/>

Expand Down Expand Up @@ -86,6 +87,7 @@ Below are some of the most common installation issues and instructions on how to
'get-started/installation-problems/svelte.mdx',
'get-started/installation-problems/vue.mdx',
'get-started/installation-problems/web-components.mdx',
'get-started/installation-problems/qwik.mdx',
]}
/>

Expand Down
15 changes: 15 additions & 0 deletions docs/get-started/installation-command-section/qwik.mdx
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.
11 changes: 11 additions & 0 deletions docs/get-started/installation-problems/qwik.mdx
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
```

0 comments on commit 34b4920

Please sign in to comment.