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

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

Vue Styleguidist is a style guide generator for Vue components. It lists component and shows live, editable usage examples based on Markdown files.

Vue Styleguidist

Isolated Vue component development environment with a living style guide

Packages

vue-styleguidist will take the results of vue-docgen-api and create a website site to showcase and develop components.


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


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

Documentation

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

Contributing

Please see contributing guide.

Note that the current monorepo relies on yarn workspaces. Don't forget to install yarn, npm i --global yarn, before cloning.

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: Help me get to conferences ;) Paypal.me donate

Logo by Benjamin Cognard.

License

MIT License

Github Repository