vue-cli-plugin-styleguidist

This is a vue-cli 3.x plugin to add vue-styleguidist in your Vue project.

Install

If you don't have a project created with Vue CLI 3:

vue create my-app

Add the plugin to your project:

cd my-app
vue add styleguidist

Usage

After installation, invoke vue-styleguidist with:

npm run styleguide

Configurations

vue-styleguidist have some plugin options in styleguide.config.js

You can read all the options here.

Contribution

This project uses a monorepo setup that requires using Yarn because it relies on Yarn workspaces.

git clone https://github.com/elevatebart/vue-cli-plugin-styleguidist.git
yarn

Run Unit Tests

yarn test

Issues and questions are more than welcome.