helper-toc

Template helper for generating a table of contents using content from the file in which the helper is used, or for a glob of files.

Install

Install with npm

npm i helper-toc --save

See the tests for actual usage and options examples.

Table of contents

• Usage
• Register
• Related projects
• Running tests
• Contributing
• Author
• License

(Table of contents generated by [verb])

Usage

var toc = require('helper-toc');

Example using Lo-Dash templates:

<%= toc("*.md") %>

Render:

// pass a string, and pass the helper on the context
var result = _.template(str)({toc: helper()});

Results in a table of contents that looks something like:

* [one.md](./one.md)
* [two.md](./two.md)
* [three.md](./one.md)

Register

Register with [template]

var Template = require('template');
var template = new Template();
template.helper('toc', require('helper-toc'));

Register with [verb]

var verb = require('verb');
verb.helper('toc', require('helper-toc'));

Register with [assemble]

var assemble = require('assemble');
assemble.helper('toc', require('helper-toc'));

Related projects

• glob-toc: Create a table of contents from a glob of files.
• markdown-toc: Generate a markdown TOC (table of contents) with Remarkable.
• pretty-remarkable: Plugin for prettifying markdown with Remarkable using custom renderer rules.
• remarkable: Markdown parser, done right. 100% Commonmark support, extensions, syntax plugins, high speed - all in… more

Running tests

Install dev dependencies:

npm i -d && npm test

Contributing

Pull requests and stars are always welcome. For bugs and feature requests, please create an issue

Author

Jon Schlinkert

• github/jonschlinkert
• twitter/jonschlinkert

License

Copyright (c) 2015 Jon Schlinkert Released under the MIT license.

This file was generated by verb-cli on May 10, 2015.