Skip to content

Latest commit

 

History

History
31 lines (18 loc) · 727 Bytes

README.md

File metadata and controls

31 lines (18 loc) · 727 Bytes

Table of Contents generated with DocToc

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 markdown files in the current directory and all its subdirectories with a table of content that will point at the anchors generated by the github markdown parser.

If you want to convert only a specific file, do:

doctoc /path/to/file

Example:

doctoc README.md