-
-
Notifications
You must be signed in to change notification settings - Fork 9.3k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Rename CLI to sb #4345
Merged
Merged
Rename CLI to sb #4345
Changes from 4 commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
5e38138
Rename storybook CLI to sb to avoid conflicts with storybook NPM script
shilman 29def99
Remove start/build commands for now
shilman a60ca2a
CLI migration/documentation updates
shilman 551537b
Merge branch 'master' into shilman/cli-rename
shilman 79499d4
Fix typo
shilman File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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
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 |
|---|---|---|
| @@ -1,42 +1,45 @@ | ||
| --- | ||
| id: 'quick-start-guide' | ||
| title: 'Quick Start Guide' | ||
| id: "quick-start-guide" | ||
| title: "Quick Start Guide" | ||
| --- | ||
|
|
||
| Storybook supports many different frontend frameworks with more coming! | ||
| Storybook supports many different frontend view layers with more coming! | ||
| React, Vue, Angular, Mithril, Marko, HTML and Svelte are currently supported. Follow these steps to get started with Storybook. | ||
|
|
||
| Get started using the automated command line tool. This command adds a set of boilerplate files for Storybook in your project: | ||
|
|
||
| ```sh | ||
| cd my-project-directory | ||
| npm i -g @storybook/cli | ||
| getstorybook | ||
| npx -p @storybook/cli sb init | ||
| ``` | ||
| The `-g` global install is used to run our cli tool in your project directory to generate templates for existing projects. To avoid the global install and setup a project manually, take a look at the [Slow Start Guide](/basics/slow-start-guide/). | ||
|
|
||
| To install storybook for HTML, add `--html` argument: | ||
| The tool inspects your `package.json` to determine which view layer you're using. If you want to develop HTML snippets in storybook, we can't determine that automatically. So to install storybook for HTML, add the `--html` argument: | ||
|
|
||
| ``` | ||
| getstorybook --html | ||
| npx -p @storybook/cli sb init --html | ||
| ``` | ||
|
|
||
| To setup a project manually, take a look at the [Slow Start Guide](/basics/slow-start-guide/). | ||
|
|
||
| Start Storybook with: | ||
|
|
||
| ```sh | ||
| npm run storybook | ||
| ``` | ||
|
|
||
| Storybook should now be available in the browser with a link provided in the console. | ||
|
|
||
| * * * | ||
| --- | ||
|
|
||
| To learn more about what `getstorybook` command does, have a look at the slow start guides: | ||
| * [React](/basics/guide-react/) | ||
| * [Vue](/basics/guide-vue/) | ||
| * [Angular](/basics/guide-angular/) | ||
| * [Mithril](/basics/guide-mithril/) | ||
| * [Marko](/basics/guide-marko/) | ||
| * [HTML](/basics/guide-html/) | ||
| * [Svelte](/basics/guide-svelte/) | ||
| * [Ember](/basics/guide-ember/) | ||
|
|
||
| - [React](/basics/guide-react/) | ||
| - [Vue](/basics/guide-vue/) | ||
| - [Angular](/basics/guide-angular/) | ||
| - [Mithril](/basics/guide-mithril/) | ||
| - [Marko](/basics/guide-marko/) | ||
| - [HTML](/basics/guide-html/) | ||
| - [Svelte](/basics/guide-svelte/) | ||
| - [Ember](/basics/guide-ember/) | ||
|
|
||
| A tutorial is also available at [Learn Storybook](https://www.learnstorybook.com) for a step-by-step guide (only available for React). |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
installing