/storybook

Storybook integration with Nuxt.js

Primary LanguageTypeScriptMIT LicenseMIT

@nuxtjs/storybook

@nuxtjs/storybook

npm version npm downloads Github Actions CI Codecov License

Storybook integration with NuxtJS

Features

  • Zero configuration
  • Nuxt webpack configuration
  • Nuxt plugins support
  • Story discovery from nuxt modules
  • Nuxt components support
  • Storybook Generate
  • Hot reload support

📖  Read more

Quick Setup

  1. Add @nuxtjs/storybook dependency to your project:
#using yarn
yarn add --dev @nuxtjs/storybook
# using npm
npm install --save-dev @nuxtjs/storybook

If you are using Nuxt < 2.14.0, you need to use core-js@3

  1. Add .nuxt-storybook and storybook-static to your .gitignore:
.nuxt-storybook
storybook-static
  1. Add **/*.stories.js to .nuxtignore
**/*.stories.js
  1. Start adding stories

Configure

Then, add storybook section in nuxt.config.js:

export default {
  storybook: {
    // Options
  }
}

See module options.

Run

Now you can use nuxt storybook to start:

# Using yarn
yarn nuxt storybook

# Using npm
npx nuxt storybook

Development

  1. Clone this repository
  2. Install dependencies using yarn install
  3. Start storybook server using yarn dev

License

MIT License

Copyright (c)