simpletoc

simpletoc

Simple Table of Contents generator for DOM and Markdown. 1.5kb

Quick dive

For the DOM

simpletoc.domToc({
  // Only search for content in a specific place.
  root: '.content',
  // Only use headings from 1 to 3 levels.
  selector: 'h1, h2, h3',
  // Where to place the generated Table of Contents.
  target: '.table-of-contents-placeholder',
  // Use an unordered list (bullet list, no numbers).
  type: 'ul',
})

For Markdown

simpletoc.mdToc(markdownText, {
  // Place to inject the generated table of contents.
  target: /Table of contents here/,
  // Use an unordered list (bullet list, no numbers).
  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

• https://github.com/gajus/contents
• https://github.com/jgallen23/toc
• https://github.com/gfranko/jquery.tocify.js
• https://github.com/tscanlin/tocbot
• https://github.com/n1k0/toctoc
• https://github.com/aslushnikov/table-of-contents-preprocessor
• https://github.com/Oktavilla/markdown-it-table-of-contents
• https://github.com/gajus/markdown-contents
• https://github.com/thlorenz/doctoc

Contributing

Please read CONTRIBUTING.md. ♥

License

MIT ♥

Changelog

v1.0.3 - 2019-11-10

• Remove Greenkeeper integration
• Upgrade all dev-dependencies