simpletoc
Simple Table of Contents generator for DOM and Markdown. 1.5kb
Quick dive
For the DOM
simpletoc.domToc({
root: '.content',
selector: 'h1, h2, h3',
target: '.table-of-contents-placeholder',
type: 'ul',
})
For Markdown
simpletoc.mdToc(markdownText, {
target: /Table of contents here/,
type: 'ul',
})
Why?
I needed to generate a table of contents and all I found was kind of overkill or bulked.
Install
$ npm install simpletoc
Or use a CDN like jsDelivr.
Browser support
simpletoc
should work in every major browser and every node.js LTS version. Distribution files are
transpiled with babel and target is defined in the .browserlistrc
file.
See the list of browsers here.
Some alternatives
Contributing
Please read CONTRIBUTING.md. ♥
License
MIT ♥