GitHub/storybook
1
0
Fork 0
mirror of https://github.com/storybookjs/storybook.git synced 2025-04-02 05:03:44 +08:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #18022 from SulthanNK/update-cli-docs

Browse Source 
Update: [#17934] CLI docs
This commit is contained in:
Kyle Gach 2022-05-16 13:10:59 -06:00 committed by GitHub
commit 0289996d85
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
12 changed files with 14 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/get-started/install.md
View File

@ -21,7 +21,7 @@ title: 'Install Storybook'
<details>
<summary><code>sb init</code> is not made for empty projects</summary>
<summary><code>storybook init</code> is not made for empty projects</summary>
Storybook needs to be installed into a project that is already set up with a framework. It will not work on an empty project. There are many ways to bootstrap an app in a given framework, including:

2
docs/get-started/installation-command-section/angular.mdx
View File

@ -2,7 +2,7 @@
```shell
# Add Storybook:
npx sb init
npx storybook init
```
- Update your `angular.json` file to include Storybook's custom builder:

2
docs/get-started/installation-command-section/ember.mdx
View File

@ -2,7 +2,7 @@ Use the Storybook CLI to install it with a couple of commands. Run this inside y
```shell
# Add Storybook:
npx sb init
npx storybook init
# Add Ember storybook adapter
ember install @storybook/ember-cli-storybook

2
docs/get-started/installation-command-section/html.mdx
View File

@ -2,7 +2,7 @@ Use the Storybook CLI to install it in a single command. Run this inside your _e
```shell
# Add Storybook:
npx sb init --type html
npx storybook init --type html
```
If you run into issues with the installation, check the [Troubleshooting section](#troubleshooting) below for guidance on how to solve it.

2
docs/get-started/installation-command-section/preact.mdx
View File

@ -2,7 +2,7 @@ Use the Storybook CLI to install it in a single command. Run this inside your _e
```shell
# Add Storybook:
npx sb init
npx storybook init
```
If you run into issues with the installation, check the [Troubleshooting section](#troubleshooting) below for guidance on how to solve it.

2
docs/get-started/installation-command-section/react.mdx
View File

@ -2,7 +2,7 @@ Use the Storybook CLI to install it in a single command. Run this inside your _e
```shell
# Add Storybook:
npx sb init
npx storybook init
```
If you run into issues with the installation, check the [Troubleshooting section](#troubleshooting) below for guidance on how to solve it.

2
docs/get-started/installation-command-section/svelte.mdx
View File

@ -2,7 +2,7 @@ Use the Storybook CLI to install it in a single command. Run this inside your _e
```shell
# Add Storybook:
npx sb init
npx storybook init
```
If you run into issues with the installation, check the [Troubleshooting section](#troubleshooting) below for guidance on how to solve it.

2
docs/get-started/installation-command-section/vue.mdx
View File

@ -2,7 +2,7 @@ Use the Storybook CLI to install it in a single command. Run this inside your _e
```shell
# Add Storybook:
npx sb init
npx storybook init
```
If you run into issues with the installation, check the [Troubleshooting section](#troubleshooting) below for guidance on how to solve it.

2
docs/get-started/installation-command-section/web-components.mdx
View File

@ -2,7 +2,7 @@ Use the Storybook CLI to install it in a single command. Run this inside your _e
```shell
# Add Storybook:
npx sb init
npx storybook init
```
If you run into issues with the installation, check the [Troubleshooting section](#troubleshooting) below for guidance on how to solve it.

2
lib/cli/src/automigrate/fixes/webpack5.ts
View File

@ -52,7 +52,7 @@ export const webpack5: Fix<Webpack5RunOptions> & CheckBuilder = {
To upgrade to the latest stable release, run this from your project directory:
${chalk.cyan('npx sb upgrade')}
${chalk.cyan('npx storybook upgrade')}
Add the ${chalk.cyan('--prerelease')} flag to get the latest prerelease.
`.trim()

4
lib/cli/src/automigrate/index.ts
View File

@ -52,7 +52,9 @@ export const automigrate = async ({ fixId, dryRun, yes }: FixOptions = {}) => {
} else {
logger.info(`Skipping the ${chalk.cyan(f.id)} fix.`);
logger.info();
logger.info(`If you change your mind, run '${chalk.cyan('npx sb@next automigrate')}'`);
logger.info(
`If you change your mind, run '${chalk.cyan('npx storybook@next automigrate')}'`
);
}
}
}

2
lib/core-server/src/utils/update-check.ts
View File

@ -38,7 +38,7 @@ export function createUpdateMessage(updateInfo: VersionCheck, version: string):
try {
const suffix = semver.prerelease(updateInfo.data.latest.version) ? '--prerelease' : '';
const upgradeCommand = `npx sb@latest upgrade ${suffix}`.trim();
const upgradeCommand = `npx storybook@latest upgrade ${suffix}`.trim();
updateMessage =
updateInfo.success && semver.lt(version, updateInfo.data.latest.version)
? dedent`