Skip to content

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

License

Notifications You must be signed in to change notification settings

bbaltutat/vue-styleguidist

 
 

Repository files navigation

Vue Styleguidist

Version downloads NPM downloads License

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

Advanced documentation

Examples

Showcases

Real projects using Vue Styleguidist:

Change log

The change log can be found on the Releases page.

Authors and license

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

MIT License

About

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

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • JavaScript 99.9%
  • HTML 0.1%