jsdoc/templates
Jeff Williams d5991a2d71 don't overwrite pages like 'index.html' if a namespace has a name like 'index' (#244)
also, improved the default template's efficiency--we now create lists
of all classes/members/etc. just once, instead of once per longname
2012-11-08 07:47:05 -08:00
..
2012-10-15 20:47:08 -07:00

To create or use your own template, create a folder, and give it the name of your template, for example "mycooltemplate". Within this folder create a file named "publish.js". That file must define a global method named "publish". For example:

/**
 * Turn the data about your docs into file output.
 * @global
 * @param {TAFFY} data - A TaffyDB collection representing
 *                       all the symbols documented in your code.
 * @param {object} opts - An object with options information.
 */
function publish(data, opts) {
    // do stuff here to generate your output files
}

To invoke JSDoc 3 with your own template, use the -t command line option, giving it the path to your template folder.

./jsdoc mycode.js -t /path/to/mycooltemplate