jsdocp

The change log page title of the generated HTML page

The format for individual commit lines produced in the change log markdown.

The markdown that will be pre-pended to the change log.

The sections within the change log which organize changes (omit output a list without sections)

Markdown used as a header when there are change log entries for breaking changes

Section grep options for breaking changes

Markdown used as a header when there are change log entries for features

Section grep options for features

Markdown used as a header when there are change log entries for fixes

Section grep options for fixes

The regular expression used as filter in the git log -grep=

true for case-insensitive git log -i

true for extended regular expressions git log -E

true to limit all regular expressions in the grep

Markdown used as a header when there are change log entries for merges

Section grep options for merges

Section options for breaking changes

Section options for features

Section options for fixes

Section options for merged/pull requests

The commit message used when deploying the documentation

The branch that where documentation will be pushed during deployment

The path where the branch will be cloned to and pushed from during deployment

The host name that will be used when cloning/pushing during deployment (e.g. github.com)

The user options that will be used when deploying the documentation pages

The configuration options

The change log options used to generate the change log file and link

The options for the generated pages naviagation menu

The versions options used to generate links to previously published version docs

true to remove the jsdoc assigned Options destination prior to publishing

The definitions used to generate link tags in the head element. Each object can have any number of properties/values that will get translated to an attribute on the link tag matching the property name and an attribute value for the value.

The definitions used to generate meta tags in the head element. Each object can have any number of properties/values that will get translated to an attribute on the meta tag matching the property name and an attribute value for the value.

The definitions used to generate script tags in the head element. Each object can have any number of properties/values that will get translated to an attribute on the script tag matching the property name and an attribute value for the value.

The layout fragments used. Typically, none of the fragment values will be overridden since they are handled internally

The documentation deployment options

The path to the template fragment that will be inserted at the end of the head section

The path to the template fragment that will be inserted at the beginning of the body section

The path to the template fragment that will be inserted at the end of the body section

The directories that the required conf.templates.default.layoutFile will be searched for in the order they are defined. Unfortunately, template implementations may store the conf.templates.default.layoutFile in different locations. By default, the most likley/typlical directories will be checked.

The path to the template/*.tmpl file used for the header at the top of the documentation page

The path to the template/*.tmpl file used for the navigation bar

The path to the template/*.tmpl file used for the footer at the bottom of the documenation page

The navigation menu options for small displays

The navigation menu options for medium displays

The navigation menu options for large displays

The CSS class applied to the main menu

The options for the logo displayed in the navigation menu

The options that apply to all of the navigation menu icons (excluding the logo)

The options for the npm package icon that will appear in the navigation menu

The options for the CHANGELOG icon that will appear in the navigation menu

The options for the source code icon that will appear in the navigation menu

The options for the documentation version selection icon that will appear in the navigation menu

The title set on the icon

The src used on the img in the navigation menu that links to the icon (omit to use the default icon)

The CSS class name assigned to the icon

The CSS class name applied to all of the icons in the navigation menu (excluding the logo)

The source URL for the logo icon dsiplayed in the navigation menu (if not overridden by inlineSvgPath)

A path to an svg logo that will be inserted inline within the navigation menu display. Will override the logo src, but if present will fall back on the src when the svg content cannot be extracted.

The CSS class name assigned to the logo icon's anchor tag

The CSS class name assigned to the logo icon loaded from the src

The navigation menu position (top, left, bottom, right)

The CSS segment that will be passed into window.matchMedia in the client's browser

true to auto hide while vertically scrolling down, show when scrolling up

The title set on the npm package icon

The src used on the img in the navigation menu that links to the npm package (omit to use the default icon)

The CSS class name assigned to the npm package icon

The destination directory where the documentation will be generated in

The jsdocp options

The git user name

The git email

A Semantic Versioning compliant version that designates the first version to show in the version drop-down selection for different docs (omit to list all of them)

A designation that inidcates what doc versions to show in the drop-down selection. A designation of major will only show versions that have been released for major_ version tags (i.e. the first number in the version). A designation of minor will only show versions that have been released for minor version tags (i.e. the second number in the version). undefined will cause the default value to be used. Any other value, or blank value will cause all versions to be included.