From 1f76bea662bc43b8329152697e2c0fb88041c6d1 Mon Sep 17 00:00:00 2001 From: Benjamin Kindle Date: Sun, 5 Feb 2023 11:01:10 -0500 Subject: [PATCH] docs: qwik install and troubleshooting instructions --- docs/get-started/install.md | 2 ++ .../installation-command-section/qwik.mdx | 15 +++++++++++++++ docs/get-started/installation-problems/qwik.mdx | 11 +++++++++++ 3 files changed, 28 insertions(+) create mode 100644 docs/get-started/installation-command-section/qwik.mdx create mode 100644 docs/get-started/installation-problems/qwik.mdx diff --git a/docs/get-started/install.md b/docs/get-started/install.md index c1eeb85883b3..77db823a856b 100644 --- a/docs/get-started/install.md +++ b/docs/get-started/install.md @@ -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', ]} /> @@ -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', ]} /> diff --git a/docs/get-started/installation-command-section/qwik.mdx b/docs/get-started/installation-command-section/qwik.mdx new file mode 100644 index 000000000000..050ca4af410a --- /dev/null +++ b/docs/get-started/installation-command-section/qwik.mdx @@ -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. diff --git a/docs/get-started/installation-problems/qwik.mdx b/docs/get-started/installation-problems/qwik.mdx new file mode 100644 index 000000000000..7a342d897b20 --- /dev/null +++ b/docs/get-started/installation-problems/qwik.mdx @@ -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 + ```