Generates a table of contents for your HTML document based on the headings present.
Where do I get it?
You can download it from github at https://github.com/matthewkastor/html-table-of-contents or, if you have node installed you can get it from npm
npm install html-table-of-contents
Using this module in your browser is as simple as including it in your page
htmlTableOfContents() after the page has loaded.
The table of contents will be generated in the first element with the id of
toc. It will consist of a series of sibling
div's whose class directly maps
to the heading level of the heading it describes. By default there is no
styling done to the table of contents, to allow you to style it however you
wish. This module comes with a css stylesheet which you can include in your
page if you would like to. The provided stylesheet simply indents entries in
the table of contents based on the heading level in the document. Take a look
at the stylesheet
html-table-of-contents.css, in this module's root folder,
to get an idea of how to access the table of contents entries if you wish to
create your own stylesheet.
If you're using this module outside of a browser you will have to supply a
reference to a dom document object, unless you've called it
and declared it globally. I did not require any specific module for parsing the
DOM, because there are a few out there and it would be rude of me to force you
to use a specific one for such a simple function.
Generating a table of contents in Browser
Generating a table of contents in Node