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

Creates a renderer function used to generate the documentation.

build.renderer(buildTemplatesPromise, options)

Registers all .mustache files in the bit-docs-generate-html/site/templates/buildHash folder as partials and creates a Renderer function that renders the content.mustache template within the layout.mustache template.

Parameters

  1. buildTemplatesPromise {Promise<Handlebars>}:

    The result of calling bit-docs-generate-html/build/templates. Building the renderer must happen after the templates have been copied over. Passing this argument enforces that.

  2. options {Object}:

    Options used to configure the behavior of the renderer.

Returns

{Promise<Renderer(docObject)>}:

A promise that resolves with the renderer function.