Skip to content

e10a/vue-styleguidist

Repository files navigation

Vue Styleguidist

Isolated Vue component development environment with a living style guide

Documentation

Docs are available at https://vue-styleguidist.github.io/ - we are still working on refining it and contributions are welcome!

Packages

vue-docgen-api will parse your vue components and load their documentation in a Javascript object

vue-styleguidist will take the results of vue-docgen-api and create a good looking site to play with your components

vue-cli-plugin-styleguidist will configure styleguidist to work smoothly with vue-cli 3

Contributing

Please see contributing guide.

Authors and license

Artem Sapegin, Rafael Escala, Bart Ledoux, react-styleguidist contributors and vue-styleguidist contributors. Thanks to the team of react-styleguidist for the amazing tool.

We work on this project because we love the open source community and learn new things.

  • Rafael: You can buy me a cup of coffee :) Paypal.me donate
  • Bart: Send me money to make chameleon stickers. I promise I will send you one if you donate. Paypal.me donate

Logo by Benjamin Cognard.

License

MIT License

About

Created from react styleguidist for Vue Components with a living style guide

Resources

License

Code of conduct

Contributing

Stars

Watchers

Forks

Packages

 
 
 

Contributors

Languages

  • TypeScript 74.7%
  • JavaScript 19.6%
  • Vue 5.3%
  • Other 0.4%