bit-docs-html-toc module

Injects a table of contents for the page into an HTML element.

function()

Returns

{undefined}:

This plugin registers onto these hooks:

  • tags
  • html

Registering the tags hook adds the @outline tag.

Registering the html hook adds a static JavaScript file used to hydrate the table of contents bit-docs-html-toc/toc.js.