Skip to content
Created from react styleguidist for Vue Components with a living style guide
Branch: dev
Clone or download
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github feat(plugin/ui): add first version of @vue/ui support Mar 18, 2019
assets
docs docs(tocs): update all table of contents sections Mar 18, 2019
examples v3.10.1 Mar 19, 2019
packages v3.10.1 Mar 19, 2019
test test(plugin): remove eslint to fix serve-babel test (#333) Mar 18, 2019
.editorconfig Updated scripts & src Jul 14, 2017
.eslintignore test(plugin): remove eslint to fix serve-babel test (#333) Mar 18, 2019
.eslintrc
.gitattributes ci(git): gitattribute needs to watch yarn.lock as well Mar 14, 2019
.gitignore feat: transfrom styleguidist into a monorepo (#293) Mar 6, 2019
.nvmrc feat: transfrom styleguidist into a monorepo (#293) Mar 6, 2019
.prettierignore feat: transfrom styleguidist into a monorepo (#293) Mar 6, 2019
.prettierrc feat: transfrom styleguidist into a monorepo (#293) Mar 6, 2019
.travis.yml ci(lerna): generate changelogs and github release Mar 19, 2019
LICENSE Initial commit Jun 11, 2017
README.md fix(assets): move logo back to root Mar 17, 2019
babel.config.js feat: transfrom styleguidist into a monorepo (#293) Mar 6, 2019
browserslist Initial project Jun 12, 2017
commitlint.config.js ci(commit): add commitlint Mar 8, 2019
cypress.json fix: update babelrc config files to the babel.config.js (#260) Jan 27, 2019
dangerfile.js ci(dangerfile): fix dangerfile issue Mar 8, 2019
jest.config.js feat: transfrom styleguidist into a monorepo (#293) Mar 6, 2019
jest.config.plugin.js feat: transfrom styleguidist into a monorepo (#293) Mar 6, 2019
lerna.json v3.10.1 Mar 19, 2019
package.json test(plugin): add missing babel dev dependencies Mar 19, 2019
tsconfig.json
yarn.lock test(plugin): add missing babel dev dependencies Mar 19, 2019

README.md

Vue Styleguidist

Isolated Vue component development environment with a living style guide

Documentation

Docs are available at https://vue-styleguidist.github.io/ - we are still working on refining it and contributions are welcome!

Packages

vue-docgen-api will parse your vue components and load their documentation in a Javascript object


vue-styleguidist will take the results of vue-docgen-api and create a good looking site to play with your components


vue-cli-plugin-styleguidist will configure styleguidist to work smoothly with vue-cli 3

Contributing

Please see contributing guide.

Note that the current monorepo relies on yarn workspaces. Don't forget to install yarn, npm i --global yarn, before cloning.

Authors and license

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

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: Help me get to conferences ;) Paypal.me donate

Logo by Benjamin Cognard.

License

MIT License

You can’t perform that action at this time.
You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session.