Created from react styleguidist for Vue Components with a living style guide
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
assets create assets folder and add logos in it Nov 10, 2018
bin fix: webpack 4 warning Nov 19, 2018
docs style: run prettier Nov 25, 2018
examples feat: Add custom properties to the JSdoc Dec 3, 2018
loaders refactor: remove chunkify.js Nov 24, 2018
scripts 1.8.5 (#192) Sep 6, 2018
src fix: remove invalid protection of null tags Dec 4, 2018
test style: run prettier Nov 25, 2018
.babelrc Chore: upgrade babel (#207) Sep 21, 2018
.editorconfig Updated scripts & src Jul 14, 2017
.eslintignore Initial project Jun 12, 2017
.eslintrc Feat: Updated with styleguidist (#175) Aug 23, 2018
.gitattributes Fix: add .gitattributes to avoid crlf issues Sep 18, 2018
.gitignore Add self deployment of docs upon update of master Nov 11, 2018
.npmignore create assets folder and add logos in it Nov 10, 2018
.nvmrc Updated with styleguidist@6.1.0 Jan 5, 2018
.prettierignore updated styleguidist@6.5.3 Mar 31, 2018
.prettierrc updated prettierrc Mar 21, 2018
.travis.yml fix(ci): reinstall node-fetch... Nov 23, 2018
LICENSE Initial commit Jun 11, 2017
README.md style: run prettier Nov 25, 2018
browserslist Initial project Jun 12, 2017
cypress.json Feat: Updated with styleguidist (#175) Aug 23, 2018
dangerfile.js Test: Added travis Jun 3, 2018
jsconfig.json Updated with styleguidist@6.1.0 Jan 5, 2018
package-lock.json chore: update vue-docgen-api Nov 29, 2018
package.json chore: update vue-docgen-api Nov 29, 2018
release.js Fix: Added vue-webpack-loaders #181 Aug 28, 2018

README.md

Vue Styleguidist

Isolated Vue component development environment with a living style guide

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.

I work in this project because I like the open source community and learn new things, however, also you can give me a cup of coffee :) Paypal.me donate

Logo by Benjamin Cognard.

MIT License