archive-gh-me/jsdoc
1
0
Fork 0
mirror of https://github.com/jsdoc/jsdoc.git synced 2025-12-08 19:46:11 +00:00
Code Issues Projects Releases Wiki Activity

long-overdue update to the template README

Browse Source
This commit is contained in:
Jeff Williams 2013-08-19 08:15:43 -07:00
parent abeb539a33
commit c48bbc006a
1 changed files with 14 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
templates/README.md
View File

@ -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
````
````