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

Clarified docs around creating and invoking custom templates. Closes issue #120

Browse Source
This commit is contained in:
Michael Mathews 2012-05-30 21:15:29 +01:00
parent 4c85e313bc
commit fed3fd076e
1 changed files with 20 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
templates/README.md Normal file
View File

@ -0,0 +1,20 @@
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:
````javascript
/**
* 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
````