/GitHub-Table-of-Contents-Generator

:key: GitHub Table of Contents Generator (C++)

Primary LanguageC++

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