Configuring JSDoc's default template
Table of Contents
- Generating pretty-printed source files
- Copying static files to the output directory
- Showing the current date in the page footer
- Showing longnames in the navigation column
- Overriding the default template's layout file
- Related Links
JSDoc's default template provides several options that you can use to customize the appearance and content of generated documentation.
To use these options, you must create a configuration file for JSDoc and set the appropriate options in the configuration file.
Generating pretty-printed source files
By default, JSDoc's default template generates pretty-printed versions of your source files. It also links to these pretty-printed files in the documentation.
To disable pretty-printed files, set the option
false. Using this option also removes links
to your source files from the documentation. This option is available in JSDoc 3.3.0 and later.
Copying static files to the output directory
JSDoc's default template automatically copies a few static files, such as CSS stylesheets, to the output directory. In JSDoc 3.3.0 and later, you can tell the default template to copy additional static files to the output directory. For example, you might want to copy a directory of images to the output directory so you can display these images in your documentation.
To copy additional static files to the output directory, use the following options:
templates.default.staticFiles.include: An array of paths whose contents should be copied to the output directory. Subdirectories will be copied as well.
templates.default.staticFiles.exclude: An array of paths that should not be copied to the output directory.
templates.default.staticFiles.includePattern: A regular expression indicating which files to copy. If this property is not defined, all files will be copied.
templates.default.staticFiles.excludePattern: A regular expression indicating which files to skip. If this property is not defined, nothing will be skipped.
Showing the current date in the page footer
By default, JSDoc's default template always shows the current date in the footer of the generated documentation. In JSDoc 3.3.0 and later, you can omit the
current date by setting the option
Showing longnames in the navigation column
By default, JSDoc's default template shows a shortened version of each symbol's name in the navigation column. For example, the symbol
my.namespace.MyClass would be displayed simply as
MyClass. To show the complete longname instead, set the option
true. This option is available in JSDoc 3.4.0 and later.
Overriding the default template's layout file
The default template uses a file named
layout.tmpl to specify the header and footer for each page in the generated documentation. In particular,
To use this feature, set the option
templates.default.layoutFile to the path to your customized layout file. Relative paths are resolved against
the current working directory; the path to the configuration file; and the JSDoc directory, in that order.
Configuring JSDoc with a configuration file