Skip to content

Commit 69f783a

Browse files
doowbdoowb
committed
run verb to generate readme
1 parent 1e8f01e commit 69f783a

File tree

2 files changed

+53
-38
lines changed

2 files changed

+53
-38
lines changed

‎.verb.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ Usage: markdown-toc [options] <input>
66
input: The Markdown file to parse for table of contents,
77
or "-" to read from stdin.
88
9-
-i: Edit the <input> file directly, injecting the TOC at <!-- toc -->
9+
-i: Edit the <input> file directly, injecting the TOC at &lt;!-- toc --&gt;
1010
(Without this flag, the default is to print the TOC to stdout.)
1111
1212
--json: Print the TOC in JSON format
@@ -26,7 +26,7 @@ Usage: markdown-toc [options] <input>
2626
text before slugifying
2727
```
2828

29-
## Highights
29+
## Highlights
3030

3131
**Features**
3232

‎README.md‎

Lines changed: 51 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
1-
# markdown-toc [![NPM version](https://img.shields.io/npm/v/markdown-toc.svg?style=flat)](https://www.npmjs.com/package/markdown-toc) [![NPM monthly downloads](https://img.shields.io/npm/dm/markdown-toc.svg?style=flat)](https://npmjs.org/package/markdown-toc) [![NPM total downloads](https://img.shields.io/npm/dt/markdown-toc.svg?style=flat)](https://npmjs.org/package/markdown-toc) [![Linux Build Status](https://img.shields.io/travis/jonschlinkert/markdown-toc.svg?style=flat&label=Travis)](https://travis-ci.org/jonschlinkert/markdown-toc)
1+
# markdown-toc [![NPM version](https://img.shields.io/npm/v/markdown-toc.svg?style=flat)](https://www.npmjs.com/package/markdown-toc) [![NPM monthly downloads](https://img.shields.io/npm/dm/markdown-toc.svg?style=flat)](https://npmjs.org/package/markdown-toc) [![NPM total downloads](https://img.shields.io/npm/dt/markdown-toc.svg?style=flat)](https://npmjs.org/package/markdown-toc) [![Linux Build Status](https://img.shields.io/travis/jonschlinkert/markdown-toc.svg?style=flat&label=Travis)](https://travis-ci.org/jonschlinkert/markdown-toc) [![Windows Build Status](https://img.shields.io/appveyor/ci/jonschlinkert/markdown-toc.svg?style=flat&label=AppVeyor)](https://ci.appveyor.com/project/jonschlinkert/markdown-toc)
22

33
> Generate a markdown TOC (table of contents) with Remarkable.
44
55
## Table of Contents
66

77
- [Install](#install)
88
- [CLI](#cli)
9-
- [Highights](#highights)
9+
- [Highlights](#highlights)
1010
- [Usage](#usage)
1111
- [API](#api)
1212
* [toc.plugin](#tocplugin)
@@ -36,15 +36,29 @@ $ npm install --save markdown-toc
3636
## CLI
3737

3838
```
39-
Usage: markdown-toc [--json] [-i] <input>
39+
Usage: markdown-toc [options] <input>
4040
41-
input: The markdown file to parse for table of contents,
42-
or "-" to read from stdin.
41+
input: The Markdown file to parse for table of contents,
42+
or "-" to read from stdin.
4343
44-
--json: Print the TOC in json format
44+
-i: Edit the <input> file directly, injecting the TOC at &lt;!-- toc --&gt;
45+
(Without this flag, the default is to print the TOC to stdout.)
4546
46-
-i: Edit the <input> file directly, injecting the TOC at <!-- toc -->
47-
(Without this flag, the default is to print the TOC to stdout.)
47+
--json: Print the TOC in JSON format
48+
49+
--append: Append a string to the end of the TOC
50+
51+
--bullets: Bullets to use for items in the generated TOC
52+
(Supports multiple bullets: --bullets "*" --bullets "-" --bullets "+")
53+
(Default is "*".)
54+
55+
--maxdepth: Use headings whose depth is at most maxdepth
56+
(Default is 6.)
57+
58+
--no-firsth1: Include the first h1-level heading in a file
59+
60+
--no-stripHeadingTags: Do not strip extraneous HTML tags from heading
61+
text before slugifying
4862
```
4963

5064
## Highlights
@@ -287,44 +301,45 @@ Pull requests and stars are always welcome. For bugs and feature requests, [plea
287301

288302
### Contributors
289303

290-
| **Commits** | **Contributor** |
291-
| --- | --- |
292-
| 190 | [jonschlinkert](https://github.com/jonschlinkert) |
293-
| 4 | [stefanwalther](https://github.com/stefanwalther) |
294-
| 3 | [Marsup](https://github.com/Marsup) |
295-
| 2 | [dvcrn](https://github.com/dvcrn) |
296-
| 2 | [maxogden](https://github.com/maxogden) |
297-
| 2 | [twang2218](https://github.com/twang2218) |
298-
| 2 | [angrykoala](https://github.com/angrykoala) |
299-
| 2 | [zeke](https://github.com/zeke) |
300-
| 1 | [Vortex375](https://github.com/Vortex375) |
301-
| 1 | [owzim](https://github.com/owzim) |
302-
| 1 | [chendaniely](https://github.com/chendaniely) |
303-
| 1 | [Feder1co5oave](https://github.com/Feder1co5oave) |
304-
| 1 | [garygreen](https://github.com/garygreen) |
305-
| 1 | [TehShrike](https://github.com/TehShrike) |
306-
| 1 | [citizenmatt](https://github.com/citizenmatt) |
307-
| 1 | [rafaelsteil](https://github.com/rafaelsteil) |
308-
| 1 | [RichardBradley](https://github.com/RichardBradley) |
309-
| 1 | [sethvincent](https://github.com/sethvincent) |
310-
| 1 | [lu22do](https://github.com/lu22do) |
304+
| **Commits** | **Contributor** |
305+
| --- | --- |
306+
| 196 | [jonschlinkert](https://github.com/jonschlinkert) |
307+
| 4 | [stefanwalther](https://github.com/stefanwalther) |
308+
| 3 | [Marsup](https://github.com/Marsup) |
309+
| 2 | [dvcrn](https://github.com/dvcrn) |
310+
| 2 | [maxogden](https://github.com/maxogden) |
311+
| 2 | [twang2218](https://github.com/twang2218) |
312+
| 2 | [angrykoala](https://github.com/angrykoala) |
313+
| 2 | [zeke](https://github.com/zeke) |
314+
| 1 | [Vortex375](https://github.com/Vortex375) |
315+
| 1 | [owzim](https://github.com/owzim) |
316+
| 1 | [chendaniely](https://github.com/chendaniely) |
317+
| 1 | [Daniel-Mietchen](https://github.com/Daniel-Mietchen) |
318+
| 1 | [Feder1co5oave](https://github.com/Feder1co5oave) |
319+
| 1 | [garygreen](https://github.com/garygreen) |
320+
| 1 | [TehShrike](https://github.com/TehShrike) |
321+
| 1 | [citizenmatt](https://github.com/citizenmatt) |
322+
| 1 | [rafaelsteil](https://github.com/rafaelsteil) |
323+
| 1 | [RichardBradley](https://github.com/RichardBradley) |
324+
| 1 | [sethvincent](https://github.com/sethvincent) |
325+
| 1 | [lu22do](https://github.com/lu22do) |
311326

312327
### Building docs
313328

314-
_(This document was generated by [verb-generate-readme](https://github.com/verbose/verb-generate-readme) (a [verb](https://github.com/verbose/verb) generator), please don't edit the readme directly. Any changes to the readme must be made in [.verb.md](.verb.md).)_
329+
_(This project's readme.md is generated by [verb](https://github.com/verbose/verb-generate-readme), please don't edit the readme directly. Any changes to the readme must be made in the [.verb.md](.verb.md) readme template.)_
315330

316-
To generate the readme and API documentation with [verb](https://github.com/verbose/verb):
331+
To generate the readme, run the following command:
317332

318333
```sh
319-
$ npm install -g verb verb-generate-readme && verb
334+
$ npm install -g verbose/verb#dev verb-generate-readme && verb
320335
```
321336

322337
### Running tests
323338

324-
Install dev dependencies:
339+
Running and reviewing unit tests is a great way to get familiarized with a library and its API. You can install dependencies and run tests with the following command:
325340

326341
```sh
327-
$ npm install -d && npm test
342+
$ npm install && npm test
328343
```
329344

330345
### Author
@@ -337,8 +352,8 @@ $ npm install -d && npm test
337352
### License
338353

339354
Copyright © 2017, [Jon Schlinkert](https://github.com/jonschlinkert).
340-
Released under the [MIT license](LICENSE).
355+
Released under the [MIT License](LICENSE).
341356

342357
***
343358

344-
_This file was generated by [verb-generate-readme](https://github.com/verbose/verb-generate-readme), v0.4.1, on January 15, 2017._
359+
_This file was generated by [verb-generate-readme](https://github.com/verbose/verb-generate-readme), v0.6.0, on September 19, 2017._

0 commit comments

Comments
 (0)