forked from thlorenz/doctoc
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
23 additions
and
4 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,8 +1,27 @@ | ||
**Table of Contents** *generated with [DocToc](http://doctoc.herokuapp.com/)* | ||
|
||
- [doc-toc](#doc-toc) | ||
- [DocToc](#doctoc) | ||
- [Installation](#installation) | ||
- [Usage](#usage) | ||
|
||
doc-toc | ||
======= | ||
# DocToc | ||
|
||
Generates table of contents for markdown files inside local git repository. Links are compatible with anchors generated by github | ||
|
||
## Installation | ||
|
||
npm install -g doctoc | ||
|
||
## Usage | ||
|
||
Go into the directory that contains you local git project and type: | ||
|
||
doctoc . | ||
|
||
This will update all markdow files with a table of content. | ||
|
||
You can then check it in, e.g.,: | ||
|
||
git commit -ma "updated markdown table of contents" | ||
git push | ||
|
||
Generates table of contents for markdown files inside local git repository. Links are compatible with anchors generated by github |