renderer

  • function
 

Creates a renderer function used to generate the documentation.

.build.renderer(buildTemplatesPromise, options)

Registers all .mustache files in the documentjs/site/templates 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 documentjs.generators.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.