bit-docs-generate-html/build/templates module

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

build.templates(siteConfig)

Builds the bit-docs-generate-html/site/templates/buildHash folder with the following steps:

  1. Copies bit-docs-generate-html/site/default/templates to bit-docs-generate-html/site/templates/buildHash.
  2. Copies siteConfig.templates to bit-docs-generate-html/site/templates/buildHash.

Parameters

  1. siteConfig {Object}:

    siteConfig 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.