GitHub TOC Sidebar

Put the GitHub README TOC in the sidebar
What is GitHub TOC Sidebar?
GitHub TOC Sidebar is a Chrome extension that enhances the accessibility of readme files on GitHub projects. It puts the Table of Contents in the sidebar, allowing you to view the outline of the content and navigate through different sections more easily.

Extension stats

By: Reorx
Users: 150 ▼ -5
Rating: 5.00 (4)
Version: 2.2.0 (Last updated: 2024-03-07)
Creation date: 2023-05-24
Risk impact: Low risk impact
Risk likelihood: Moderate risk likelihood
Manifest version: 3
Size: 9.97K

Other platforms

Not available on Firefox
Not available on Edge
Want to check extension ranking and stats more quickly for other Chrome extensions? Install Chrome-Stats extension to view Chrome-Stats data as you browse the Chrome Web Store.
Chrome-Stats extension

Extension 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/<user>/<project>, not subsidiary pages like https://github.com/<user>/<project>/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

User reviews

it's very useful for me
by Ryan Liu, 2024-06-28

Very easy to use, this is a amazing plug -in matching with GitHub.
by phrank, 2023-08-12

很好用,滚动页面自动弹出,方便
by Tan Song, 2023-07-31
View all user reviews

Extension safety

Risk impact

GitHub TOC Sidebar requires very minimum permissions.

Risk likelihood

GitHub TOC Sidebar is probably trust-worthy. Prefer other publishers if available. Exercise caution when installing this extension.

Upgrade to see risk analysis details

Similar extensions

Here are some Chrome extensions that are similar to GitHub TOC Sidebar: