DocToc

Generates table of contents for markdown files inside local git repository. Links are compatible with anchors generated by github or bitbucket via a command line flag.

Table of Contents generated with DocToc

• Installation
• Usage
  • Adding toc to all files in a directory and sub directories
  • Adding toc to a single file
    • Example
  • Using doctoc to generate links compatible with other sites
    • Example

Installation

npm install -g doctoc

Usage

Adding toc to all files in a directory and sub directories

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.

Adding toc to a single file

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

doctoc /path/to/file

Example

doctoc README.md

Using doctoc to generate links compatible with other sites

In order to add a table of contents whose links are compatible other sites add the appropriate mode flag:

Available modes are:

--bitbucket	bitbucket.org
--nodejs	  nodejs.org
--github	  github.com
--gitlab	  gitlab.com
--ghost	    ghost.org

Example

doctoc README.md --bitbucket