Skip to content

Build a markdown table of contents for all the markdown files in a given directory tree.

Notifications You must be signed in to change notification settings

kolychev/markdown-index

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

7 Commits
 
 
 
 
 
 
 
 

Repository files navigation

markdown-index

Build a markdown table of contents for all the markdown files in a given directory tree.

This node module is a command line tool that traverses a given directory for all markdown files (with extension .md) and compiles all of their tables of contents into one giant markdown string. All the tables of contentses!

Installation

Install markdown-index globally so it's available on your path.

npm install -g markdown-index

Usage

Give markdown-index a directory to traverse, and it outputs the indexed content to stdout.

markdown-index directory/fulla/markdowns > index.md

License

MIT

About

Build a markdown table of contents for all the markdown files in a given directory tree.

Resources

Stars

Watchers

Forks

Packages

No packages published

Languages

  • JavaScript 100.0%