<commit_before># remark-toc [![Build Status](https://img.shields.io/travis/wooorm/remark-toc.svg)](https://travis-ci.org/wooorm/remark-toc) [![Coverage Status](https://img.shields.io/codecov/c/github/wooorm/remark-toc.svg)](https://codecov.io/github/wooorm/remark-toc)

Generate a Table of Contents (TOC) for [Markdown](http://daringfireball.net/projects/markdown/syntax)
files with [remark](https://github.com/wooorm/remark).

## Installation

[npm](https://docs.npmjs.com/cli/install):

```bash
npm install remark-toc
```

[Component.js](https://github.com/componentjs/component):

```bash
component install wooorm/remark-toc
```

[Bower](http://bower.io/#install-packages):
<commit_msg>Add temporary warning to `readme.md`<commit_after># remark-toc [![Build Status](https://img.shields.io/travis/wooorm/remark-toc.svg)](https://travis-ci.org/wooorm/remark-toc) [![Coverage Status](https://img.shields.io/codecov/c/github/wooorm/remark-toc.svg)](https://codecov.io/github/wooorm/remark-toc)

Generate a Table of Contents (TOC) for [Markdown](http://daringfireball.net/projects/markdown/syntax)
files with [remark](https://github.com/wooorm/remark).

> :warning: **mdast is currently being renamed to remark** :warning:
> 
> This means all plug-ins and relating projects change too, causing many
> changes across the ecosystem. Expect the dust to settle in roughly a day.
> 
> See this project at the previous stable commit
> [c4a51d1](https://github.com/wooorm/remark-github/commit/c4a51d1).

## Installation

[npm](https://docs.npmjs.com/cli/install):

```bash
npm install remark-toc
```

[Component.js](https://github.com/componentjs/component):

```bash
component install wooorm/remark-toc
```

[Bower](http://bower.io/#install-packages):

{'fraction_non_alphanumeric': 0.17889908256880735, 'fraction_numerical': 0.0045871559633027525, 'mean_word_length': 5.1879432624113475, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 10, 'https://': 15, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '1236735', 'n_tokens_mistral': 643, 'n_tokens_neox': 594, 'n_words': 104}