bit-docs-html-toc

bit-docs-html-toc

A table of contents for use with bit-docs-generate-html.

Use

To use, add bit-docs-html-toc to your bit-docs dependencies in package.json:

{
  ...

  "bit-docs": {
    "dependencies": {
      "bit-docs-html-toc": "$VERSION"
    }
  }
}

Where $VERSION is the latest version on npm.

In your template add a class on-this-page-container:

<div class="on-this-page-container"></div>

By default, all heading tags children of the first article tag on the page will be collected to create the table of contents; if you want to use a different element just do:

<div 
  class="on-this-page-container"
  data-heading-container-selector="#my-custom-selector"
>
</div>

The table of contents will be injected into this element at run time.

To control the number of child headers that will be included in the TOC, use the @outline tag like so:

@outline 2

This will include <h2> and <h3> elements, rather than the normal <h2> only.