# 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.

Latest version **0.2.0** (published 2015-05-10) · MIT license · 0 weekly downloads

## Install

```sh
npm install helper-toc
pnpm add helper-toc
yarn add helper-toc
bun add helper-toc
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.2.0 |
| Published | 2015-05-10 |
| First published | 2015-05-02 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=0.10.0 |
| Dependencies | 6 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Jon Schlinkert |
| Maintainers | jonschlinkert |
| Keywords | contents, helper, markdown, md, table, table-of-contents, template, toc |

## Links

- npm: https://www.npmjs.com/package/helper-toc
- Repository: https://github.com/jonschlinkert/helper-toc
- Issues: https://github.com/jonschlinkert/helper-toc/issues
- npm.io page: https://npm.io/package/helper-toc

## Dependencies (6)

- [globby](https://npm.io/package/globby.md) ^2.0.0
- [glob-toc](https://npm.io/package/glob-toc.md) ^0.1.2
- [relative](https://npm.io/package/relative.md) ^3.0.0
- [mixin-deep](https://npm.io/package/mixin-deep.md) ^1.1.0
- [markdown-toc](https://npm.io/package/markdown-toc.md) ^0.11.3
- [markdown-utils](https://npm.io/package/markdown-utils.md) ^0.6.1

## Alternatives

- [@mdxeditor/editor](https://npm.io/package/@mdxeditor/editor.md) — 962.4K weekly downloads
- [mmdb-lib](https://npm.io/package/mmdb-lib.md) — 680.9K weekly downloads
- [playcanvas](https://npm.io/package/playcanvas.md) — 36.2K weekly downloads
- [@glw907/cairn-cms](https://npm.io/package/@glw907/cairn-cms.md) — 967 weekly downloads
- [markdown-to-confluence](https://npm.io/package/markdown-to-confluence.md) — 103 weekly downloads

## Recent versions

- 0.2.0 (latest) — 2015-05-10
- 0.1.2 — 2015-05-02
- 0.1.0 — 2015-05-02

## README

# helper-toc [![NPM version](https://badge.fury.io/js/helper-toc.svg)](http://badge.fury.io/js/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](https://www.npmjs.com/)

```bash
npm i helper-toc --save
```

See the [tests](./tests/test.js) for actual usage and options examples.

# Table of contents

<!-- toc -->

* [Usage](#usage)
* [Register](#register)
* [Related projects](#related-projects)
* [Running tests](#running-tests)
* [Contributing](#contributing)
* [Author](#author)
* [License](#license)

_(Table of contents generated by [verb])_

<!-- tocstop -->

## Usage

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

Example using Lo-Dash templates:

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

Render:

```js
// 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:

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

## Register

**Register with [template]**

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

**Register with [verb]**

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

**Register with [assemble]**

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

## Related projects

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

## Running tests

Install dev dependencies:

```bash
npm i -d && npm test
```

## Contributing

Pull requests and stars are always welcome. For bugs and feature requests, [please create an issue](https://github.com/jonschlinkert/helper-toc/issues/new)

## Author

**Jon Schlinkert**

+ [github/jonschlinkert](https://github.com/jonschlinkert)
+ [twitter/jonschlinkert](http://twitter.com/jonschlinkert)

## License

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

***

_This file was generated by [verb-cli](https://github.com/assemble/verb-cli) on May 10, 2015._

---
_Source: https://npm.io/package/helper-toc · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._