bit-docs-html-toc/toc.js module

Main front end JavaScript file for static portion of this plugin.

TOCContainer(el)

Hydrates the container element with class on-this-page-container with the headers from the page.

If DEPTH was specified to the @outline tag, then only headers less than and including that depth will be hydrated.

Parameters

  1. el {HTMLElement}:

    The HTML element to hydrate.