nuxt-histoire

[DEPRECATED] Use the official module instead -> https://github.com/histoire-dev/histoire/blob/main/packages/histoire-plugin-nuxt/README.md

This module is a simple wrapper around histoire. To learn more about it, please visit the official documentation.

Usage

yarn add --dev nuxt-histoire # yarn
npm i --save-dev nuxt-histoire # npm

// nuxt.config.js

{
  modules: [
    "nuxt-histoire",
  ],
  histoire: {
    disabled?: boolean, // disable on production
    configuration?: HistoireConfig // Coming soon!
  }
}

Add following script to your package.json file:

"story:dev": "nuxt prepare && histoire dev"

Run the command:

yarn story:dev # yarn
npm run story:dev # npm

Features

• Nuxt 3 ready
• No configuration setup
• TypeScript support

Development

• Run npm run dev:prepare to generate type stubs.
• Use npm run story:dev to start [histoire playground] in development mode.