@nuxtjs/storybook
TypeScript icon, indicating that this package has built-in type declarations

7.0.2 • Public • Published

Nuxt Storybook

Nuxt Storybook

Integrate Storybook into your Nuxt application.

Installing

pnpm add -D @nuxtjs/storybook

Update your nuxt.config:

  modules: [
    '@nuxtjs/storybook',
  ],
  storybook: {
    url: 'http://localhost:6006',
    storybookRoute: '/__storybook__',
    port: 6006,
  },

Then run pnpm dev to start you Nuxt server.

Demo

https://github.com/storybook-vue/nuxt-storybook-module-demo

Features

👌 Zero configuration to start (see video)

🪄 Access Storybook Terminal

🎨 Devtools tab with Storybook app

⚙️ Reference your Storybook config in your app

📦 Extendable by Nuxt modules

🚀 Supports Nuxt 3 / Storybook 7

Nuxt 2

Nuxt 2 is supported with Storybook v6,you can check legacy code on the v4 branch.

Contributing

  1. Install dependencies with pnpm.
  2. Run pnpm dev:prepare to generate stubbed dist directory.
  3. Make your changes.
  4. Run pnpm lint to verify that there is no issues (consider adding tests).
  5. Submit a PR.

License

This repository is licensed under the MIT License. Feel free to use the code and modify it according to your needs.

Contacts :

🔖 Mail: javachakir@gmail.com

💬 Discord: ChakAs3

🐦‍⬛ Twitter: @ChakirQatab

Dependents (4)

Package Sidebar

Install

npm i @nuxtjs/storybook

Weekly Downloads

19,204

Version

7.0.2

License

MIT

Unpacked Size

11.7 kB

Total Files

10

Last publish

Collaborators

  • farnabaz
  • pi0
  • javachakir-npm