React inspired style guide generator for Vue.js
🙀 [20/09/2017] Project discontinued 🙀
For purpose of having a demo of your Vuejs components please take a look at following projects that do really great job and are really handy for you dev workflow with Vuejs: storybook for vuejs and vue-styleguidist.
Initially started after reading this vue.js feature request. Now only basic proof of concept is available which can load folder with .vue files, parse it and extract basic props of it.
Target is to have some tool with at least some of the React version capabilities.
Idea is to have what vue-play does but in automated way - with one task run, plus READMEs, etc.
Generate single html file containing all components listed with details and search out from your .vue project files.
npm install vue-styleguide-generator --save-dev
add to you package.json in script section - for example like this
"build-components": "node ./node_modules/vue-styleguide-generator/"and then run
npm run build-componentsfrom the root folder of the project.
🏃 You can also manually (or using Gulp/Grunt) run
✅ Works only for Vue 2.x projects.
| Name | Type | Description | Default | | ---: | ---- | ------ |------------ | | --src | String|Source dir, will be recursively scanned|src| | --dest | String|Destination output dir, file index.html will be placed there| components-preview| | --exclude| RegExp|File mask to exclude certain type of files|/^./| | --locale|String|Output locale language|en| | --verbose| String|Output all details while processing| false| | --all| String|Do not ignore any components| false| | --o| String|Open browser preview after generating| false|
node ./node_modules/vue-styleguide-generator/ --src components --dest previewwill read components from PROJECTROOT/components folder and provide a html page into PROJECTROOT/preview folder
To see all parser error run with DEBUG:
DEBUG=app node ./node_modules/vue-styleguide-generator/
If you want to see more information about the component - add a .md file in the same directory. While retrieving the files the following assumptions are made: - if there are files with the same name in one folder (e.g.
/scr/partials/TabBar.md) it's assumed to be one component; - if there are only two files in the folder and one is .vue and another is .md (e.g.
/scr/partials/readers.md) it's assumed to be one component; - If there are >1 .vue files in the folder and .md file that does not have the same name as one of the .vue files - this .md file is ignored - Components with no props, no computed and no methods defined are considered to be a simple wrappers and not outputed
Especially on following: - translations - extra features - implementing SSR
Now as from 0.9.11 also your
.jsfiles referenced from
.vuefiles are supported.
-ooption to open the browser. Refactoring the template. Added pt-br translation by israelss.
UI improvements (UX of the search block, 'Copy' component code).