Giter Club home page Giter Club logo

storybook's Introduction

@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
  • Nuxt server middlewares

📖  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. 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

Gitpod

Open in Gitpod

License

MIT License

Copyright (c)

storybook's People

Contributors

farnabaz avatar renovate[bot] avatar renovate-bot avatar atinux avatar farnabaz-t avatar pi0 avatar benjamincanac avatar decipher avatar may17 avatar tobiasdiez avatar lihbr avatar scscgit avatar danielroe avatar ingvoo avatar geminii avatar maxma241 avatar timbenniks avatar valernyx avatar vdiachenko avatar winteryukky avatar harashoo avatar romevangrinsven avatar

Watchers

James Cloos avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.