Code Monkey home page Code Monkey logo

gittoc's Introduction

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) within release version by pyinstaller. Now you can click gitToc_GUI.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:

gittoc's People

Contributors

holy-shine avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.