mirror of
https://github.com/jsdoc/jsdoc.git
synced 2025-12-08 19:46:11 +00:00
efaeea4d24
The three css files moved were not used by the default template. I only had them there so the prettyPrintSource plugin would work. Since plugins can use templates without ruining everything I've moved the css files to their proper place and copy them over in templates\prettyPrintSource\publish.js This makes it possible to enable the plugin and get the same results with any template. Now all I need to figure out is how to inject links to the generated pages into the docs...
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