Skip to content
/ doctoc Public
forked from thlorenz/doctoc

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

License

Notifications You must be signed in to change notification settings

eyalbe4/doctoc

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

38 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

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

About

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

Resources

License

Security policy

Stars

Watchers

Forks

Packages

No packages published

Languages

  • JavaScript 100.0%