JSPM

  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 3365
  • Score
    100M100P100Q129442F

Linkify HTML headers and generate a TOC.

Package Exports

  • toc

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (toc) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

toc Build Status

Linkify HTML headers and generate a TOC.

Getting Started

Install the module with: npm install toc

var toc = require('toc');

Documentation

toc.untag

Strip HTML tags from a string.

var stripped = toc.untag(html);

toc.anchor

Convert a string of text into something URL-friendly and not too fugly.

var anchor = toc.anchor(arbitraryText);

toc.unique

Get a unique name and store the returned name in names for future unique-name-gettingness.

var names = {};
var guaranteedUniqueAnchor1 = toc.unique(names, toc.anchor(arbitraryText));
var guaranteedUniqueAnchor2 = toc.unique(names, toc.anchor(arbitraryText));

toc.process

var htmlWithAnchorsAndTOC = toc.process(html [, options]);

options

  • tocMin - Number - Min header level to add to TOC. Defaults to 2.
  • tocMax - Number - Max header level to add to TOC. Defaults to 6.
  • anchorMin - Number - Min header level to anchorize. Defaults to 2.
  • anchorMax - Number - Max header level to anchorize. Defaults to 6.
  • header - String | Function - Lodash template string or function used to anchorize a header.
  • toc - String | Function - Lodash template string or function used to wrap the generated TOC.
  • openUL - String | Function - Lodash template string or function used to generate the TOC.
  • closeUL - String | Function - Lodash template string or function used to generate the TOC.
  • openLI - String | Function - Lodash template string or function used to generate the TOC.
  • closeLI - String | Function - Lodash template string or function used to generate the TOC.
  • placeholder - RegExp - Used to match TOC placeholder. Defaults to /<!--\s*toc\s*-->/gi.

Examples

You can customize the hell out of the generated HTML, eg.

var htmlWithAnchorsAndTOC = toc.process(html, {
  header: '<h<%= level %><%= attrs %> id="<%= anchor %>"><%= header %></h<%= level %>>',
  toc: '<div class="toc"><%= toc %></div>',
  openUL: '<ul data-depth="<%= depth %>">',
  closeUL: '</ul>',
  openLI: '<li data-level="H<%= level %>"><a href="#<%= anchor %>"><%= text %></a>',
  closeLI: '</li>',
});

Contributing

In lieu of a formal styleguide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code using Grunt.

Release History

2013-03-07 - v0.1.0 - First official release.

License

Copyright (c) 2013 "Cowboy" Ben Alman
Licensed under the MIT license.