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

Builds a static distributable which will eventually be copied to the static folder of the generated output.

staticDist(options)

Builds the static distributable with the following steps:

  1. Copies everything from bit-docs-generate-html/site/default/static to bit-docs-generate-html/site/static/build/buildHash.

  2. Copies the path in options.dest to bit-docs-generate-html/site/static/build/buildHash.

  3. requires the "build" module at bit-docs-generate-html/site/static/build/buildHash/build.js.

  4. Calls that "build" module function with the options and returns the result.

The "build" module is expected to build a minified distributable and copy the necessary contents to bit-docs-generate-html/site/static/dist/buildHash and return a promise that resolves when complete.

Parameters

  1. options {Object}:
    • forceBuild {Boolean}

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

    • dest {String}

      The final destination output of the static distributable.

    • static {String}

      The location of static content used to overwrite or add to the default static content.

    • minifyBuild {Boolean}

      If set to false the build will not be minified. This behavior should be implemented by the "build" module.

Returns

{Promise}:

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