vue-styleguidist

⚠️ This project is archived

I haven't seriously worked on vue-styleguidist in the past 4 years. Parental and professional duties tend to take a lot of my time, and this project deserves more attention than I can give it. So I've decided to archive it.

If you have a real understanding of the field, coupled with a need for this product, get in touch with me on Mastodon and make your case. I will happily hand over the keys to a trusted maintainer.

Alternatives are legion, so you should not be left alone:

• Storybook Docs
• Histoire
• Pure Astro websites

Isolated Vue component development environment with a living style guide

Start documenting now on codesandbox.io

Sponsors

A big thank you to our sponsors.

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