❤
npm
Sign UpSign In

gitflow-publisher-jsdoc

1.1.34 • Public • Published

gitflow-publisher-jsdoc

a JSDoc documentation compiler for gitflow-publisher

VERSION DOWNLOADS ISSUES LICENCE

BUILD STANDARDJS DEPENDENCIES

NPM

overview

This gitflow-publisher plugin module, compiles the JSDoc Api documentation prior committing and publishing.

usage

var Publisher = require('gitflow-publisher');
var GitflowJSDocPublisher = require('gitflow-publisher-jsdoc');
 
var publisher = new Publisher();
 
publisher.use(new GitflowJSDocPublisher({
   "config": "./jsdoc.config.json",
   "readme": "./README.md"
}))
 
publisher.publish({...})

goodies

This package also includes a watch process for auto generating the jsdoc documentation on file change

var Publisher = require('gitflow-publisher');
var GitflowJSDocPublisher = require('gitflow-publisher-jsdoc');
 
var watcher = new GitflowJSDocPublisher({
   "config": "./jsdoc.config.json",
   "readme": "./README.md"
})
 
watcher.watch()

copyright and license

Code and documentation copyright 2016 akon. Code released under the MIT license.

Readme

Keywords

Package Sidebar

Install

npm i gitflow-publisher-jsdoc

Repository

github.com/akonoupakis/gitflow-publisher-jsdoc

Homepage

github.com/akonoupakis/gitflow-publisher-jsdoc

Weekly Downloads

5

Version

1.1.34

License

MIT

Last publish

Collaborators

  • akon
Try on RunKit
Report malware