Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added Quick Start section #100

Merged
merged 4 commits into from
Nov 15, 2017
Merged

Added Quick Start section #100

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
32e3e68
Added Quick Start section
dbooth-boston Oct 25, 2017
398bc33
Corrected toc marker
dbooth-boston Oct 25, 2017
d3d5aa9
Single backticks inline
dbooth-boston Oct 25, 2017
81c44bd
Restored README.md from 3c6eb6a5c67707eeced3f0822e9a3a160d4b7321
dbooth-boston Oct 25, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 7 additions & 1 deletion .verb.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
## Quick Start
Assuming you want to add a TOC to README.md:
1. `$ npm install -g markdown-toc`
2. Edit README.md and insert the following line where you want the TOC inserted:<br />`<!-- toc -->`
3. `$ markdown-toc -i README.md`

## CLI

```
Expand Down Expand Up @@ -253,4 +259,4 @@ Type: `Boolean`

Default: `true`

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