bit-docs-generate-html module

Generates HTML for a docMap and handles the html hook.

function()

Returns

{undefined}:

This plugin registers onto these hooks:

  • tags
  • generator

Registering the tags hook adds the @templaterender tag.

Registering the generator hook makes it so this plugin can generate the HTML output from the provided DocMap. The entry point for this generator is bit-docs-generate-html/html.

This plugin handles the html hook, which allows other plugins to hook into the generation process, to do things like include their own static assets, or provide their own mustache templates.

This plugin provides a default set of mustache templates and static assets. These mustache templates and less styles can be copied over into a theme plugin and customized. Any custom mustache template will override a default of the same name.