Git Product home page Git Product logo

github-table-of-contents-generator's Introduction

GitHub Table of Contents Markdown Generator

Preview

Overview

This is a simple program that was coded in C++ that allows the user to upload their README.md file (or any markdowned file) and generate a Table of Contents with it.

Usage

This program can work with other types of GitHub marked files. Using this program is simple: All you need to do is type in your project name into the first textbox and your username into the second textbook. Then select your .md file.

The reasoning for putting in your project name and username is for the purpose of formatting your hyperlinks. The bottom far left button will allow you to change between numbers and bullets (see images above & below).

Examples

Preview

I used my Dreamstride YGOPro Archetype and aframe by aframevr to test this program out. If you take a look at both of the respiratories, you can see that one is simple and the other one is complex. Everything seems to format fine despite that design and complexity within someone's markdown.

Example 1 (Dreamstride-YGOPro-)

Example 2 (aframe)

  1. Features
  2. Usage
  3. Example
  4. Builds
  5. npm
  6. Or yarn add aframe
  7. Local Development
  8. Generating Builds
  9. Questions
  10. Stay in Touch
  11. Contributing
  12. License

github-table-of-contents-generator's People

Contributors

ahxr avatar

Watchers

 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.