GitHub TOC Sidebar

SUMMARY

GitHub TOC Sidebar enhances the accessibility on the readme of GitHub projects. It utilizes the builtin TOC (Table of Contents) component in GitHub, when scrolling down, the TOC will be opened and stick on the right side of the page, making it easier to view the outline of the content, and quicker to navigate around different sections. It's quite helpful when viewing projects that has long readme with multi-level table of contents.

Please note that this extension only works when all the circumstances are met:
1. You are viewing the home page of a project on GitHub, meaning that the URL must match the format https://github.com//, not subsidiary pages like https://github.com///blob/master/readme.md
2. The project has a readme file written in a markup language such as Markdown or RST
3. The readme file has headings that split content into multiple sections with titles
4. You scroll down the page further than the bottom of the right sidebar

To test if this extension works, you can open this page as an example: https://github.com/reorx/awesome-chatgpt-api

The latest version of GitHub TOC Sidebar is available on the Chrome web and is currently being used by 137 active users. The initial version was launched on 2023-05-24.

HOW TO INSTALL GitHub TOC Sidebar FROM A CRX FILE

1. Download GitHub TOC Sidebar CRX file
2. NOTE: Sometimes the browser may block downloading / installing CRX file from outside the Chrome Web Store. If so, you may need to download the ZIP file instead
3. In the URL bar, go to chrome://extensions
4. Enable Developer mode

Ratings

USER REVIEWS (0)