Put the GitHub README TOC in the sidebar

Latest Version

Version
2.2.0
Update
March 7, 2024
Size
9.74KiB
Developer
Category
Users
143
Rating
5 ★
Manifest Version
3
Web Store Status
Languages Support
English
See more
Permissions
See more

GitHub TOC Sidebar Extension

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
Read more

Source Manifest.json

{"update_url": "https://clients2.google.com/service/update2/crx", "manifest_version": 3, "name": "GitHub TOC Sidebar", "description": "Put the GitHub README TOC in the sidebar", "version": "2.2.0", "icons": { "16": "icon.png", "48": "icon.png", "128": "icon.png" }, "content_scripts": [ { "matches": [ "https://github.com/*/*" ], "css": [ "css/content_style.css" ], "js": [ "js/content_script.js" ] } ]}
Read more

How to download and manually install GitHub TOC Sidebar extension for Chrome

Looking for a way to install GitHub TOC Sidebar extensions for Chrome, you can search for them in the Chrome Web Store, clicking the "Add to Chrome" button, and following the straightforward process.

However, you may need to install GitHub TOC Sidebar extensions manually, this article outlines two simple methods to effortlessly install GitHub TOC Sidebar extensions, whether they come as unpacked folders in compressed formats like .zip or as .crx files.

Method 1: Download GitHub TOC Sidebar extension and manually install through Drag &Drop

If you ever need to manually install a GitHub TOC Sidebar extension for Chrome, don't worry, it's a simple process. Just follow these easy steps, and you will have your extension ready to use in no time.

Step 1: Download the GitHub TOC Sidebar Extension by clicking the "Download CRX" button on the website.

Look for the GitHub TOC Sidebar extension you wish to install. Go to the website and download the GitHub TOC Sidebar extension package, which is usually a .CRX file and comes in a zipped file. Here ".crx" file is the format for GitHub TOC Sidebar extension that contains all the data.

Step 2: Extract &Arrange Files

Once the file is downloaded, extract that file into its own folder. Similarly, give that extension files a permanent home. In other words, keep it in a folder that you don't accidentally delete it because these files will be needed to make that extension work.

Step 3: Go to the Chrome Extensions Page

Open Google Chrome and in the address bar, type chrome://extensions; it will open the Google Chrome extensions page. Make sure that "My extensions" is selected in the sidebar.

Step 4: Drag and Drop the Extension

Now, go to the folder where you extracted the GitHub TOC Sidebar extension and drag &drop the extension file from there anywhere onto the extension page within Google Chrome.

Step 5: Complete the Installation

Once you drag and drop the extension file, follow the steps that Google Chrome takes you through. Similarly, if the extension file is of .crx file format, you will be required to review the permissions and then add the extension.

Now, you can manage that added extension as you would like to with any other Chrome extension that you added through Chrome Webstore. Its icon will also appear in the Google Chrome Menu on the right side of the address bar once you activate it.

Method 2: Download GitHub TOC Sidebar extension for Chrome and install in Developer Mode

This is another method to install GitHub TOC Sidebar extension manually, but the twist is that here, you install by enabling the developer mode option provided in Google Chrome. This mode is commonly used for testing extensions or running unpublished tools.

Step 1: Download the GitHub TOC Sidebar extension file

Select and download the GitHub TOC Sidebar extension by clicking the 'Download CRX' button on the website.

Step 2: Extract the downloaded contents

Convert the file to a ZIP file if it is in CRX format then extract the GitHub TOC Sidebar extension zip file or folder that you downloaded. Make sure you extract it using the same folder name and keep it safely in another folder, so you don't delete it by mistake. The extracted folder will be needed to keep your GitHub TOC Sidebar extension running.

Step 3: Open Chrome Extension Setting Page

In the address bar of Google Chrome, type chrome://extensions and open the Chrome Extension Page.

Step 4: Enable Developer Mode

After opening the Chrome Extension page, look at the top right side, and you will find the toggle option of "Developer mode."Simply enable that developer mode option.

Step 5: Load the Unpacked Extension

Once you enable the developer mode option, you will see the menu of Load Unpacked, Pack Extensions and Update. From that, select the option "Load unpacked."

Step 6: Select the Extension Folder

Once the pop-up opens upon clicking Load unpacked, select the GitHub TOC Sidebar extension directory and click on the "Select Folder "button.

Step 7: Confirm and Install

After you select an extension folder of a Google Chrome extension you're installing manually, confirm its installation for the final time and let the installation complete.

Conclusion

Here we've made a step-by-step guide on How to manually install GitHub TOC Sidebar extension in 2 ways. We hope this guide proves helpful.

Similar Extensions

icon

GitHub-Markdown-TOC Extension · Social & Communication 143 4 ★ 47.62KiB

icon

Kimi Copilot - 网页总结助手 Extension · Productivity 143 100 ★ 227KiB

icon

Douban Book+ Extension · Productivity 143 75 ★ 2.09MiB

icon

Omni - Bookmark, History, & Tab Manager Extension · Productivity 143 63 ★ 1.91MiB

icon

Minimal Bilibili Extension · Productivity 143 1 ★ 47.47KiB

icon

Smart TOC Extension · Productivity 143 100 ★ 81.44KiB

icon

BewlyBewly Extension · Productivity 143 332 ★ 1.06MiB

icon

Elmo Chat - Your AI Web Copilot Extension · Productivity 143 86 ★ 12.05MiB

icon

Relingo - Master Words | Bilingual Subtitles | Immersive Translate | Free Extension · Productivity 143 802 ★ 5.36MiB

icon

AI TOC Extension · Productivity 143 1 ★ 124KiB

icon

V2EX Polish Extension · Productivity 143 95 ★ 193KiB

icon

Modern for Hacker News Extension · Productivity 143 31 ★ 6.79MiB

icon

RSSHub Radar Extension · Productivity 143 60 ★ 1.54MiB

icon

為什麼你們就是不能加個空格呢? Extension · Productivity 143 415 ★ 2.5MiB

icon

Maple Bookmarks Extension · Productivity 143 11 ★ 29.91KiB

icon

Gitako - GitHub file tree Extension · Developer Tools 143 78 ★ 1.96MiB

icon

v2ex plus Extension · Productivity 143 102 ★ 64.7KiB

icon

Huntly Extension · Productivity 143 5 ★ 209KiB

icon

Twitter Bird Shield Extension · Social & Communication 143 48 ★ 528KiB

icon

Refined GitHub Extension · Developer Tools 143 213 ★ 572KiB

icon

KISS Translator Extension · Productivity 143 35 ★ 852KiB

icon

GitHub Hovercard Extension · Developer Tools 143 41 ★ 121KiB

icon

Cubox Extension · Productivity 143 86 ★ 5.63MiB

icon

File Icons for GitHub and GitLab Extension · Developer Tools 143 48 ★ 460KiB

User reviews

icon

phrank (ID: 00000086a5be807a) Voted 5 ★ - Updated 08/12/2023 Very easy to use, this is a amazing plug -in matching with GitHub.

icon

Tan Song (ID: 000000f4b5a57b57) Voted 5 ★ - Updated 07/31/2023 很好用,滚动页面自动弹出,方便

icon

Zero Ricardo (ID: 00000027350df5a0) Voted 5 ★ - Updated 07/30/2023 Works great and is very low invasive