templates

  • function
 

Creates a folder with all the templates used to generate the documentation.

.build.templates(options)

Builds the documentjs/site/templates folder with the following steps:

  1. Copies documentjs/site/default/templates to documentjs/site/templates.
  2. Copies options.templates to documentjs/site/templates.

Parameters

  1. options {Object}

    Options used to configure the behavior of the templates.

    • forceBuild {Boolean}

      If set to true, rebuilds the static bundle even if it has already been built.

    • templates {String}

      The location of templates used to overwrite or add to the default templates.

Returns

{Promise}

A promise that resolves if the static dist was successfully created.