Skip to content

Commit

Permalink
updated readme
Browse files Browse the repository at this point in the history
  • Loading branch information
thlorenz committed May 28, 2012
1 parent 1ac46cd commit 83d9715
Showing 1 changed file with 23 additions and 4 deletions.
27 changes: 23 additions & 4 deletions README.md
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

0 comments on commit 83d9715

Please sign in to comment.