0.0.1 • Published 6 years ago

parcel-plugin-jsdoc v0.0.1

Weekly downloads
-
License
MIT
Repository
-
Last release
6 years ago

parcel-plugin-jsdoc

a very simple plugin to make jsdoc with parcel.js

npm -i parcel-plugin-jsdoc -D

//or

yarn add parcel-plugin-jsdoc -D

First Step

You must install jsdoc

npm -i jsdoc -D

Second Step

you must create a jsdoc.json config file (more info about jsdoc config file jsdoc )

//simple file jsdoc.json
{
	"source": {
		"include": [ "src/" ]
	},
	"opts": {
		"destination": "./docs/",
		"recurse": true
	}
}

Now you can use this plugin. Just run your parcel command and let'go. After each parcel compilation jsdoc build a new doc for you