Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Generates table of contents for markdown files inside local git repository. Links are compatible with anchors generated by github
branch: master

This branch is 58 commits behind thlorenz:master

Fetching latest commit…

Cannot retrieve the latest commit at this time

Failed to load latest commit information.
lib
test/lib
.gitignore
.travis.yml
LICENSE
README.md
doctoc.js
package.json

README.md

DocToc build status

Generates table of contents for markdown files inside local git repository. Links are compatible with anchors generated by github

Table of Contents generated with DocToc

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
Something went wrong with that request. Please try again.