Skip to content

Joel-Liju/HackTheNorthProject

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

40 Commits
 
 
 
 

Repository files navigation

Github Documentation Parser

This Chrome extension gets all the headers of the documentation of a Github repository and conveniently puts them in a side menu for you! This will help you to easily traverse long repo documentation.

User Guide

How to get started

1. Clone this repo
2. Enter chrome://extensions/ in your browser, open developer mode in the upper right corner
3. Click the loading button in the upper left corner, select the path of src folder
4. Pin this chrome extension to your browser
5. Open any git document, click the extension icon

Features of the extension

As soon as you start the extension, first thing you will notice is, on the left hand side, there will be a small menu, which can be collapsed or not. However, within it, you will be able to use the links to each part of the document. Like a table of contents, this is intented to make it easier to navigate through the documentation of github repos.

Authors

Joel Liju-Jacob, Rodrigo Vega, Yilu Liang, Samuel Ogunleye

About

This is a project for the Hack the north, where the aim is to create a chrome extension to help people with reading the README files of github.

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors