rwparris2/vue-doc-generator

Parses Vue single file components and outputs a JSON representation of the components.

vue-doc-generator

A pretty good vuejs component documentation generator

Install

Install with npm

$ npm i vue-doc-generator --save-dev

Usage

const VueDocGenerator = require('vue-doc-generator');
const docGenerator = new VueDocGenerator({ 
	src: [path.join(__dirname, '..', './src/**/*.+(js|vue)')] 
});
const docs = docGenerator.runDocs();

You can use the above lines in conjunction with webpack's DefinePlugin to provide docs to the rest of your app.

---

Contributing

Pull requests and stars are always welcome. For bugs and feature requests, please create an issue

Committing

npm run commit launches a commit assistant to follow commitizen guidelines

---

Author

• github/rwparris2
• twitter/rwparris2

License

Copyright © 2018 Licensed under the MIT license.

---