# glob-toc

> Create a table of contents from a glob of files.

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

## Install

```sh
npm install glob-toc
pnpm add glob-toc
yarn add glob-toc
bun add glob-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.1.2 |
| Published | 2015-05-10 |
| First published | 2015-05-10 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=0.10.0 |
| Dependencies | 3 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 3 |
| Author | Jon Schlinkert |
| Maintainers | jonschlinkert |

## Links

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

## Dependencies (3)

- [globby](https://npm.io/package/globby.md) ^2.0.0
- [pad-left](https://npm.io/package/pad-left.md) ^1.0.2
- [markdown-utils](https://npm.io/package/markdown-utils.md) ^0.6.1

## Recent versions

- 0.1.2 (latest) — 2015-05-10
- 0.1.1 — 2015-05-10
- 0.1.0 — 2015-05-10

## README

# glob-toc [![NPM version](https://badge.fury.io/js/glob-toc.svg)](http://badge.fury.io/js/glob-toc)  [![Build Status](https://travis-ci.org/jonschlinkert/glob-toc.svg)](https://travis-ci.org/jonschlinkert/glob-toc)

> Create a table of contents from a glob of files.

## Install

Install with [npm](https://www.npmjs.com/)

```bash
npm i glob-toc --save
```

## Usage

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

Results in a table of contents like:

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

## Related projects

* [helper-toc](https://github.com/jonschlinkert/helper-toc): Template helper for generating a table of contents using content from the file in which… [more](https://github.com/jonschlinkert/helper-toc)
* [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/glob-toc/issues/new)

## Author

**Jon Schlinkert**

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

## License

Copyright (c) 2015 [Jon Schlinkert](https://github.com/jonschlinkert)
Released under the [MIT](https://github.com/jonschlinkert/glob-toc/blob/master/LICENSE) license.

***

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

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