Skip to content

Commit

Permalink
update quick start guide
Browse files Browse the repository at this point in the history
  • Loading branch information
danielduan committed Jul 26, 2018
1 parent 15b1073 commit 99a195a
Showing 1 changed file with 7 additions and 7 deletions.
14 changes: 7 additions & 7 deletions docs/src/pages/basics/quick-start-guide/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,28 +3,28 @@ id: 'quick-start-guide'
title: 'Quick Start Guide'
---

Storybook is very easy to use. You can use it with any kind of React or Vue or Angular or Mithril project.
Follow these steps to get started with Storybook.
Storybook supports many different frontend frameworks with more coming!
React, Vue, Angular, Mithril, Marko, and HTML are currently supported. Follow these steps to get started with Storybook.

Get started using our 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
```
The `-g` global install is used to run our cli tool in your project directory to generate templates for your existing projects. To avoid the global install and start your project manually, take a look at our [Slow Start Guide](/basics/slow-start-guide/).
The `-g` global install is used to run our cli tool in your project directory to generate templates for your existing projects. To avoid the global install and setup your project manually, take a look at our [Slow Start Guide](/basics/slow-start-guide/).

To install storybook for HTML, add `--html` argument:
```
getstorybook --html
```

This will configure your app for Storybook. After that, you can run your Storybook with:

You can run your Storybook with:
```sh
npm run storybook
```

Then you can access your storybook from the browser.
Storybook should now be available in your browser with the link provided in the console.

* * *

Expand All @@ -37,4 +37,4 @@ To learn more about what `getstorybook` command does, have a look at our slow st
* [HTML](/basics/guide-html/)


If you prefer a guided tutorial to reading docs, head to [Learn Storybook](https://www.learnstorybook.com) for a step-by-step guide (currently React-only).
If you prefer a guided tutorial to reading docs, head to [Learn Storybook](https://www.learnstorybook.com) for a step-by-step guide (only available for React).

0 comments on commit 99a195a

Please sign in to comment.