A Shell script to automatically generate a Table of Contents from Markdown files.

• Installation
  • NPM
  • Manually
• Usage
  • NPM
  • Manually
• Documentation
  • ...opts

npm install -g make-toc

1. Clone the repo or download as a ZIP and extract it.
2. Add the markdown file you want to generate a ToC for to the project's folder.

make-toc ...opts source-file.md output-file.md

. ./make-toc.sh ...opts source-file.md output-file.md

• source-file.md - The markdown file a ToC should be generated for.
• output-file.md - A filename to label the script's output, e.g. toc.md.

This section outlines flags for the script which may be used individually or in combination.

Skips n headers from the top of the file.

For example, to omit the file's title header use:

make-toc -s 1 source.md target.md

Sets the maximum depth for the table.

For example, to generate a fairly shallow table of the top-level and second-level headers only, use:

make-toc -d 2 source.md target.md

Passing -d 0 to the script will result in default behaviour, i.e. full depth.