Component Style Guide
We are creating a library of components that can be found here:
- vue-styleguidist: Created from react styleguidist for Vue Components with a living style guide.
- zeplin-cli-connect-plugin-vue: Zeplin CLI plugin, to send Vue component snippets to Zeplin
vue-styleguidist
Develop
The following command will start a dev server with the style guide.
npm run styleguide
This will serve the styleguide on http://localhost:6060/
Documenting a component
- (skip this step if the component already exist) Create a new Vue component under
components/commons/ui-general/
. - Add code comments to the component. Official styleguidist documentation.
- Create a markdown file matching it to document examples of it. You can follow the existing components on
styleguide/commons/ui-general/
. - Add your component to
styleguide.config.js
under thecomponents
section.
Build for production
npm run styleguide:build
This will create the styleguide
folder. It contains a static version of the guide to be deployed.