@troglotit/vue styleguidist

Vue components style guide generator

Version: 1.3.0 Updated: 07/26/2017

By: vue-styleguidist License: MIT

Downloads Last 30 Days: 13

Vue Styleguidist

npm NPM downloads

Style guide — documentation — component workbench

Project was started when not finding a tool that generates documentation of components with hot reloading, read documentation and have a playground. Created from React Styleguidist, implement additional support to read and compile .vue files. Only supports 2.x.

Vue Styleguidist is a style guide generator for Vue components. It lists component and shows live, editable usage examples based on Markdown files. You can use it to generate a static HTML page to share and publish or as a workbench for developing new components using hot reloaded dev server.

Usage

Showcases

If you have a project published, you can share it here

Examples

Advanced documentation

Authors and license

Artem Sapegin, contributors and Rafael Escala. Thanks to the team of react-styleguidist by the amazing tool.

MIT License

Contributors



troglotit
commits
Categories: Vue js