diff --git a/templates/README.md b/templates/README.md index fbdd7dbf..48c04441 100644 --- a/templates/README.md +++ b/templates/README.md @@ -1,20 +1,27 @@ -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: +To create or use your own template: + +1. Create a folder with the same name as your template (for example, `mycooltemplate`). +2. Within the template folder, create a file named `publish.js`. This file must be a CommonJS module that exports a method named `publish`. + +For example: ````javascript +/** @module publish */ + /** - * Turn the data about your docs into file output. - * @global + * Generate documentation output. + * * @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) { +exports.publish = function(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. +To invoke JSDoc 3 with your own template, use the `-t` command line option, and specify the path to your template folder: ```` ./jsdoc mycode.js -t /path/to/mycooltemplate -```` \ No newline at end of file +````