Generate a Readme toc for your Github repository.
This simple script can parse your markdown file and generate a Toc like this:
This generated toc supports inner page jumping.
Assuming that your target file's name is targetFile.md
. Just type this command in shell:
> python gitToc.py targetFile.md
You will get a new markdown file named targetFile_with_toc.md
in current directory.
-
Windows
This simple script has been packed into windows PE file(.exe) within release version by pyinstaller. Now you can click
gitToc_GUI.exe
directly and do transformation job in your Windows PC.
The author @lzw5399 made an online conversion tool TocGenerator based on GitToc.
TocGenerator Github link: https://github.com/lzw5399/TocGenerator
Online conversion address: https://toc.codepie.fun/
Instructions: