Zengtudor/Nuxt
1
0
Fork 0
mirror of https://github.com/nuxt/nuxt.git synced 2024-11-30 09:27:13 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
Sébastien Chopin 2018-02-06 13:20:38 +01:00 committed by GitHub
parent 39bddf9d6c
commit c9598993c5
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 10 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
examples/storybook/README.md
View File

@ -4,35 +4,38 @@ Demo showcasing [Storybook](https://storybook.js.org/) usage with Nuxt.js, [Vuet
## Features ## Features
* supports '~' and '~~' Nuxt.js aliases * Supports `~` and `~~` Nuxt.js aliases
* contains storybase.js with helper classes * Contains `storybase.js` with helper classes
* integrates most of addons * Integrates most of addons
* real life examples with Vuetify and Vue-Charts * Real life examples with Vuetify and Vue-Charts
## Description ## Description
This demo aims to integrate all the above mentioned technologies with best practices in mind. This demo aims to integrate all the above mentioned technologies with best practices in mind.
Points of interest Points of interest
* `.storybook` folder contains storybook configuration * `.storybook` folder contains storybook configuration
* `stories` folder has number of stories corresponding to `components` * `stories` folder has number of stories corresponding to `components`
* Note, Storybook is configured to understand Nuxt aliases `~` and `~~` * Note, Storybook is configured to understand Nuxt aliases `~` and `~~`
* number of helpers in storybase.js to simplify storybook usahe * Number of helpers in `storybase.js` to simplify storybook usahe
## Usage ## Usage
To run locally in dev mode To run locally in dev mode
``` ```
npm run storybook npm run storybook
``` ```
and then access the storybook from [localhost:9001](http://localhost:9001) and then access the storybook from [localhost:9001](http://localhost:9001)
To build static storybook to `.out` folder To build static storybook to `.out` folder
``` ```
npm run storybookoutput npm run storybookoutput
``` ```
## More reading ## More reading
* [Using Storybook with Nuxt](https://davidwalsh.name/storybook-nuxt) by David Walsh * [Using Storybook with Nuxt](https://davidwalsh.name/storybook-nuxt) by David Walsh