HTML-Contents

Creates a table of contents in a DOM element optionally linked to with anchors. No dependencies.

@psalmody

Get It

We're on npm:

``bash
npm i html-contents
`

Download from GitHub: https://github.com/psalmody/html-contents

Use It

No jQuery needed. Just include this script:

`html

`

And call like this.

`html

`

Optionally put some options in there:

`js
//these are the defaults
document.addEventListener("DOMContentLoaded", function(event) {
htmlContents('#toc', {
top: 2, // 1-6: biggest header to include in outline
bottom: 3, // 1-6: smallest header to include in outline
addIds: true, // true/false: add ids to H* that don't have them
addLinks: true, //true/false: add links to outline?
listType: 'u', // 'u' or 'o': (u)nordered or (o)rdered list type
filter: false // String or function: CSS style selector to exclude from outline
// or function to filter to pass to Array.filter
})
})
`

See It

You can run gulp and localhost:3000 to see a working example (it's also in test/index.html`)