Need help with vue-styleguidist?
Click the “chat” button below for chat support from the developer who created it, or find similar developers for support.

About the developer

vue-styleguidist
2.0K Stars 345 Forks MIT License 2.4K Commits 37 Opened issues

Description

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

Services available

!
?

Need anything else?

Contributors list

Vue Styleguidist

Isolated Vue component development environment with a living style guide

Start documenting now on codesandbox.io

Start documenting

Sponsors

A big thank you to our sponsors. Their contributions pay for the Netlify build minutes.

Marcello Bachechi, Walter Tommasi, Luca Ban and Ben Hong

Packages

vue-styleguidist takes the results of vue-docgen-api and creates a website to showcase and develop components.


vue-docgen-api parses vue components and load their documentation in a JavaScript object.


vue-inbrowser-compiler takes vue components code written in es6 and uses buble to make it compatible with all browser.


vue-cli-plugin-styleguidist configures vue-styleguidist to work with vue-cli 3.


vue-docgen-cli is a command line interface generating documentation files automatically from vue-docgen-api. Generate markdown by default but can be configured to generate whatever text format you desire.

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.

Logo by Benjamin Cognard.

License

MIT License

We use cookies. If you continue to browse the site, you agree to the use of cookies. For more information on our use of cookies please see our Privacy Policy.