markdown-toc
Advanced tools
Comparing version 0.8.0 to 0.8.1
{ | ||
"name": "markdown-toc", | ||
"description": "Generate a markdown TOC (table of contents) with Remarkable.", | ||
"version": "0.8.0", | ||
"version": "0.8.1", | ||
"homepage": "https://github.com/jonschlinkert/markdown-toc", | ||
@@ -34,2 +34,3 @@ "author": { | ||
"devDependencies": { | ||
"helper-related": "^0.1.0", | ||
"mocha": "*", | ||
@@ -36,0 +37,0 @@ "should": "*" |
@@ -1,2 +0,2 @@ | ||
# markdown-toc [![NPM version](https://badge.fury.io/js/markdown-toc.svg)](http://badge.fury.io/js/markdown-toc) | ||
# markdown-toc [![NPM version](https://badge.fury.io/js/markdown-toc.svg)](http://badge.fury.io/js/markdown-toc) [![Build Status](https://travis-ci.org/jonschlinkert/markdown-toc.svg)](https://travis-ci.org/jonschlinkert/markdown-toc) | ||
@@ -18,2 +18,7 @@ > Generate a markdown TOC (table of contents) with Remarkable. | ||
## Related projects | ||
* [remarkable](https://github.com/jonschlinkert/remarkable): Markdown parser, done right. 100% Commonmark support, extensions, syntax plugins, high speed - all in one. | ||
* [markdown-utils](https://github.com/jonschlinkert/markdown-utils): Micro-utils for creating markdown snippets. | ||
## Usage | ||
@@ -121,2 +126,10 @@ | ||
Params: | ||
- `str` **{String}** the actual heading string | ||
- `ele` **{Objecct}** object of heading tokens | ||
- `arr` **{Array}** all of the headings objects | ||
**Example** | ||
From time to time, we might get junk like this in our TOC. | ||
@@ -128,3 +141,3 @@ | ||
Unless you like that kind of thing, you might want to filter these bad headings out | ||
Unless you like that kind of thing, you might want to filter these bad headings out. | ||
@@ -137,5 +150,6 @@ ```js | ||
var result = toc(str, {filter: removeYunk}); | ||
//=> beautiful TOC, sans "Yunk"? | ||
// wtf is "Yunk" anyway? Regardless, | ||
// it will be gone. | ||
//=> beautiful TOC, sans "Yunk"? wtf is "Yunk" | ||
// anyway? Look, j and y are kind of sort of | ||
// close on the keyboard. Regardless, it gets the | ||
// yunk out of your headings. | ||
``` | ||
@@ -192,6 +206,6 @@ | ||
Copyright (c) 2014-2015 Jon Schlinkert | ||
Released under the license | ||
Released under the MIT license | ||
*** | ||
_This file was generated by [verb](https://github.com/assemble/verb) on February 24, 2015._ | ||
_This file was generated by [verb-cli](https://github.com/assemble/verb-cli) on March 02, 2015._ |
13687
207
3