The Hyperlinked Index MD Generator is a simple tool that creates structured and navigable markdown file that serve as comprehensive indexes (or table of contents) for project directories. It's available both as a web app and a command-line interface (CLI).
Motivation for this project: I maintain a repository where I push all my data structure and algorithm problems, as well as my LeetCode practice exercises. I wanted to use a navigable index as my README because I wished to see all the problems I've solved on the main GitHub project page. A hyperlinked table of contents seemed like a good idea, but I couldn't find any robust solution for it. Hence, I created this project.
Access the live web application here.
For those who prefer working in a terminal environment locally, the CLI version offers powerful and flexible options. Please refer to these guidelines
Contributions are welcome! Contributing guidelines is in progress
This project is licensed under the GNU GENERAL PUBLIC LICENSE.