klarkc/vue-styleguidist

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

Vue Styleguidist

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

• Getting Started: install and run Vue Styleguidist
• Documenting components: how to write documentation
• Locating components: point Vue Styleguidist to your Vue components
• Configuring webpack: tell Vue Styleguidist how to load your code
• Cookbook: how to solve common tasks with Vue Styleguidist

Advanced documentation

• Configuration
• CLI commands and options
• Node API

Examples

• Basic style guide, source
• Buefy style guide with sections, customized styles. source

Showcases

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

Change log

The change log can be found on the Releases page.

Authors and license

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

MIT License