glob-toc

Create a table of contents from a glob of files.

Install

Install with npm

npm i glob-toc --save

Usage

var toc = require('glob-toc');
toc('*.md');

Results in a table of contents like:

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

Related projects

• helper-toc: Template helper for generating a table of contents using content from the file in which… more
• 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.