bit-docs/lib/generate/generate module

generate(siteConfig)

Generates documentation using specified generators.

Parameters

  1. siteConfig {Object}:

    siteConfig that configures the files processed, how they are processed, and how the output is generated.

    • generators {moduleName|Array<moduleName>}

      Generators specifies a generator module or array of modules used to create an output for documentation. The default generator is "html" which is handled by bit-docs-generate-html.

      You can specify other modules which will be passed a promise containing the DocMap and the siteConfig and be expected to return a promise that resolves when they are complete.

    • watch {Boolean}

      If true, regenerates all generators when a file matched by siteConfig.glob is changed.

Returns

{Promise}:

A promise that resolves when the documentation has been successfully created.