Skip to content

Commit 65a23eb

Browse files
committed
update docs
1 parent 389e1e7 commit 65a23eb

File tree

3 files changed

+25
-14
lines changed

3 files changed

+25
-14
lines changed

.verb.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -231,3 +231,12 @@ Type: `Boolean`
231231
Default: `true`
232232

233233
Exclude the first h1-level heading in a file. For example, this prevents the first heading in a README from showing up in the TOC.
234+
235+
236+
### options.stripHeadingTags
237+
238+
Type: `Boolean`
239+
240+
Default: `true`
241+
242+
Strip extraneous HTML tags from heading text before slugifying. This is similar to GitHub markdown behavior.

README.md

Lines changed: 15 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -20,15 +20,8 @@
2020
* [options.bullets](#optionsbullets)
2121
* [options.maxdepth](#optionsmaxdepth)
2222
* [options.firsth1](#optionsfirsth1)
23+
* [options.stripHeadingTags](#optionsstripheadingtags)
2324
- [About](#about)
24-
* [Related projects](#related-projects)
25-
* [Contributing](#contributing)
26-
* [Contributors](#contributors)
27-
* [Release history](#release-history)
28-
* [Building docs](#building-docs)
29-
* [Running tests](#running-tests)
30-
* [Author](#author)
31-
* [License](#license)
3225

3326
_(TOC generated by [verb](https://github.com/verbose/verb) using [markdown-toc](https://github.com/jonschlinkert/markdown-toc))_
3427

@@ -270,6 +263,14 @@ Default: `true`
270263

271264
Exclude the first h1-level heading in a file. For example, this prevents the first heading in a README from showing up in the TOC.
272265

266+
### options.stripHeadingTags
267+
268+
Type: `Boolean`
269+
270+
Default: `true`
271+
272+
Strip extraneous HTML tags from heading text before slugifying. This is similar to GitHub markdown behavior.
273+
273274
## About
274275

275276
### Related projects
@@ -286,9 +287,9 @@ Pull requests and stars are always welcome. For bugs and feature requests, [plea
286287

287288
### Contributors
288289

289-
| **Commits** | **Contributor**<br/> |
290+
| **Commits** | **Contributor** |
290291
| --- | --- |
291-
| 178 | [jonschlinkert](https://github.com/jonschlinkert) |
292+
| 190 | [jonschlinkert](https://github.com/jonschlinkert) |
292293
| 4 | [stefanwalther](https://github.com/stefanwalther) |
293294
| 3 | [Marsup](https://github.com/Marsup) |
294295
| 2 | [dvcrn](https://github.com/dvcrn) |
@@ -331,13 +332,13 @@ $ npm install -d && npm test
331332
**Jon Schlinkert**
332333

333334
* [github/jonschlinkert](https://github.com/jonschlinkert)
334-
* [twitter/jonschlinkert](http://twitter.com/jonschlinkert)
335+
* [twitter/jonschlinkert](https://twitter.com/jonschlinkert)
335336

336337
### License
337338

338-
Copyright © 2016, [Jon Schlinkert](https://github.com/jonschlinkert).
339-
Released under the [MIT license](https://github.com/jonschlinkert/markdown-toc/blob/master/LICENSE).
339+
Copyright © 2017, [Jon Schlinkert](https://github.com/jonschlinkert).
340+
Released under the [MIT license](LICENSE).
340341

341342
***
342343

343-
_This file was generated by [verb-generate-readme](https://github.com/verbose/verb-generate-readme), v0.2.0, on December 09, 2016._
344+
_This file was generated by [verb-generate-readme](https://github.com/verbose/verb-generate-readme), v0.4.1, on January 15, 2017._

package.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,7 @@
4545
},
4646
"dependencies": {
4747
"concat-stream": "^1.5.2",
48+
"diacritics-map": "^0.1.0",
4849
"gray-matter": "^2.1.0",
4950
"lazy-cache": "^2.0.2",
5051
"list-item": "^1.1.1",

0 commit comments

Comments
 (0)