Added Quick Start section #100
Conversation
.verb.md
Outdated
| ## 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 -->``` |
There was a problem hiding this comment.
This should be
<!-- toc -->
Missing !
There was a problem hiding this comment.
Oops, good catch! I'll fix the PR in a moment ...
There was a problem hiding this comment.
No problem. Your quick start was very useful to me as a new user 👍
There was a problem hiding this comment.
Thanks @dbooth-boston! There are a couple of changes that can be made. Also, will you remove the changes from the README.md (there seems to be an issue with the generated output). I'll update that after merging the PR.
.verb.md
Outdated
| @@ -1,3 +1,9 @@ | |||
| ## Quick Start | |||
| Assuming you want to add a TOC to README.md: | |||
| 1. ```$ npm install -g markdown-toc``` | |||
There was a problem hiding this comment.
You only need 1 backtick when the code is inline.
.verb.md
Outdated
| 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``` |
There was a problem hiding this comment.
You only need 1 backtick when the code is inline.
|
Thanks @dbooth-boston! I requested some changes in a review. Once those are done, I'll merge. |
|
Ok @doowb it should be fixed now. I corrected the backticks and reverted the README.md . Thanks! |
|
@doowb it looks like this is approved and ready to merge now. |
|
@dbooth-boston thanks for the ping. I'll merge and get the readme updated soon. |
Added a simple Quick Start section to the README.md (via .verb.md).