vue-styleguidist
TypeScript icon, indicating that this package has built-in type declarations

4.72.4 • Public • Published
Vue Styleguidist

Isolated Vue component development environment with a living style guide

Version Travis CI (unit & lint) Circle CI (integration)

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 vue 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

Advanced documentation

Examples

Showcases

Real projects using Vue Styleguidist:

Change log

The change log can be found on the Releases page.

Authors and license

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

Readme

Keywords

none

Package Sidebar

Install

npm i vue-styleguidist

Weekly Downloads

6,226

Version

4.72.4

License

MIT

Unpacked Size

528 kB

Total Files

215

Last publish

Collaborators

  • elevatebart
  • rafaesc92
  • vue-styleguidist-bot