Skip to content

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

License

Notifications You must be signed in to change notification settings

Lirt/markdown-toc-bash

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

4 Commits
 
 
 
 
 
 
 
 

Repository files navigation

Markdown ToC

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

Table of Contents

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.

About

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

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages