Install Webpack if you don’t have it already, this is how we determine if your version of Webpack is compatible with styleguidist.
Install Styleguidist:
If you use Vue CLI 3 (@vue/cli (opens new window)), you should probably use the plugin
and use Vue CLI documentation
# 2. Configure your style guideCreate a styleguide.config.js
file in the same directory that your package.json
. This will be your configuration file. In this file, you can :
If you’re using Vue-CLI 3 (opens new window) you can skip the webpack step. When you install vue-cli-plugin-styleguidist, styleguidist picks up what it needs from the CLI. Then tell it where to find the components
# 3. Add npm scripts for convenienceAdd these scripts to your package.json
:
Run npm run styleguide
to start style a guide dev server.
Run npm run styleguide:build
to build a static version.
See how to document your components
# Have questionsRetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4