Skip to content

Commit e10f43e

Browse files
authored
Merge pull request #100 from dbooth-boston/quick-start
Added Quick Start section
2 parents 3c6eb6a + 81c44bd commit e10f43e

File tree

1 file changed

+7
-1
lines changed

1 file changed

+7
-1
lines changed

.verb.md

+7-1
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
1+
## Quick Start
2+
Assuming you want to add a TOC to README.md:
3+
1. `$ npm install -g markdown-toc`
4+
2. Edit README.md and insert the following line where you want the TOC inserted:<br />`<!-- toc -->`
5+
3. `$ markdown-toc -i README.md`
6+
17
## CLI
28

39
```
@@ -253,4 +259,4 @@ Type: `Boolean`
253259

254260
Default: `true`
255261

256-
Strip extraneous HTML tags from heading text before slugifying. This is similar to GitHub markdown behavior.
262+
Strip extraneous HTML tags from heading text before slugifying. This is similar to GitHub markdown behavior.

0 commit comments

Comments
 (0)