mirror of
https://github.com/jsdoc/jsdoc.git
synced 2025-12-08 19:46:11 +00:00
fc2b4ad3d2
- In the default template, look for the list of static file paths in the config property `templates.default.staticFiles.include`. (You can still use `paths` instead of `include`.) - Handle path-normalization issues that prevented the default template from copying user-specified static files on Windows. - Normalize paths in `fs.toDir` so that callers get the correct path separator on Windows.
To create or use your own template:
- Create a folder with the same name as your template (for example,
mycooltemplate). - Within the template folder, create a file named
publish.js. This file must be a CommonJS module that exports a method namedpublish.
For example:
/** @module publish */
/**
* 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.
*/
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, and specify the path to your template folder:
./jsdoc mycode.js -t /path/to/mycooltemplate