Lirt/markdown-toc-bash

Bash script to generate table of contents from markdown file (README.md)

Markdown ToC

Simple bash script to generate table of contents from a markdown file (most commonly README.md)

Table of Contents

• Markdown ToC
  • Usage
  • Contribution

Usage

Only dependency is bash.

To generate ToC, run following command. The ToC will be echoed to command line. Afterwards you can put the ToC output into your markdown file and it will link your headings.

./markdown-toc.sh README.md

Contribution

Any issues or improvements can be reported using GitHub issues.