Skip to content

thuwyq/GitToc

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

17 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

HitCount

GitToc

Generate a Readme toc for your Github repository.

中文版

Glimpse

This simple script can parse your markdown file and generate a Toc like this:

This generated toc supports inner page jumping.

Usage

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.

Platform

  • Windows

    This simple script has been packed into windows PE file(.exe) by pyinstaller. Now you can click gitToc.exe directly and do transformation job in your Windows PC.

Online Usage

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:

About

🔨Generate a Readme Toc for your Github repo. 为你的Github Readme自动生成一个目录

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages

  • Python 100.0%