jsdoc-vue

A jsdoc plugin that parses *.vue files.
16,700 69
Install
npm install jsdoc-vue
Latest Version:1.0.0
License:WTFPL
Last Updated:Jan 18, 2017
Links: GitHub  ·  npm
Maintainer: qingwei.li

jsdoc-vue

Build Status npm XO code style

A jsdoc plugin that parses *.vue files.

Installation

yarn add jsdoc-vue vue-template-compiler --dev
# $ npm i jsdoc-vue vue-template-compiler -D

Usage

Configuring JSDoc with conf.json

{
  "plugins": ["node_modules/jsdoc-vue"],
  "source": {
    "includePattern": "\\.(vue|js)$"
  }
}

Test

npm test

Related Packages

vue-docgen-api

Toolbox to extract information from Vue component files for documentation genera...

43,652,778 2,491
jsdoc-vuejs

A JSDoc plugin for documenting vue 3 files.

177,915 236
vuepress-jsdoc

Generate jsdoc markdown files for vuepress

14,297 75
ub-jsdoc

JSDoc 3 Template / Theme generated using VueJS SSR

6,785 12

Version History

Version Released License
1.0.0 WTFPL
0.1.4 WTFPL
0.1.3 WTFPL
0.1.2 WTFPL
0.1.1 WTFPL