bit-docs-generate-html/write/doc_object module

Writes out a DocObject.

docObject(docObject, renderer, siteConfig, setCurrentDocObjectForHelpers)

Parameters

  1. docObject {DocObject}:

    The DocObject to be written out.

  2. renderer {Renderer(docObject)}:

    A function that renders the output.

  3. siteConfig {Object}:

    Configuration siteConfig.

    • dest {String}

      The folder name this file will be written to. The filename is determined from the DocObject's name.

  4. setCurrentDocObjectForHelpers {function(bit-docs/types/docObject)}:

Returns

{Promise}:

A promise that resolves when the file has been written out.