Adds a navigation menu to readme file in GitHub sidebar.

Latest Version

Version
1.0.2
Update
July 30, 2015
Size
8.44KiB
Developer
Category
Users
75
Rating
1.5 ★
Manifest Version
2
Web Store Status
Languages Support
English
See more
Permissions
Https://github.com/*/*
WebNavigation
See more

GitHub Markdown Sidebar Menu Extension

GitHub README documents don't always include a Table of Contents. Well-documented repos have longer documents that can be difficult to navigate. This extension will automagically generate and add a navigation menu with a table of contents in GitHub repo homepage sidebar.

Click on a link to scroll to that section of the document. That's it!

---

Permissions requested:

- Read and change your data on github.com

This extension is scoped and enabled only when accessing https://github.com/*. This extension looks for Markdown headers, generates a navigation menu and adds it to Markdown views on GitHub.

- Read your browsing history

For this extension to work across page navigations within github.com, permissions are necessary to use chrome.webNavigation.onHistoryStateUpdated. This lets the extension hook into page navigations and trigger without full page refreshes.

This extension is open source and available at: https://github.com/amowu/github-markdown-menu
Read more

Source Manifest.json

{"update_url": "https://clients2.google.com/service/update2/crx", "name": "__MSG_appName__", "version": "1.0.2", "manifest_version": 2, "description": "__MSG_appDescription__", "icons": { "16": "images/icon-16.png", "48": "images/icon-48.png", "128": "images/icon-128.png" }, "default_locale": "en", "background": { "persistent": false, "scripts": [ "scripts/background.js" ] }, "content_scripts": [ { "matches": [ "https://github.com/*/*" ], "js": [ "scripts/contentscript.js" ], "css": [ "styles/contentstyle.css" ] } ], "permissions": [ "https://github.com/*/*", "webNavigation" ]}
Read more

How to download and manually install GitHub Markdown Sidebar Menu extension for Chrome

Looking for a way to install GitHub Markdown Sidebar Menu 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 Markdown Sidebar Menu extensions manually, this article outlines two simple methods to effortlessly install GitHub Markdown Sidebar Menu extensions, whether they come as unpacked folders in compressed formats like .zip or as .crx files.

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

If you ever need to manually install a GitHub Markdown Sidebar Menu 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 Markdown Sidebar Menu Extension by clicking the "Download CRX" button on the website.

Look for the GitHub Markdown Sidebar Menu extension you wish to install. Go to the website and download the GitHub Markdown Sidebar Menu extension package, which is usually a .CRX file and comes in a zipped file. Here ".crx" file is the format for GitHub Markdown Sidebar Menu 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 Markdown Sidebar Menu 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 Markdown Sidebar Menu extension for Chrome and install in Developer Mode

This is another method to install GitHub Markdown Sidebar Menu 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 Markdown Sidebar Menu extension file

Select and download the GitHub Markdown Sidebar Menu 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 Markdown Sidebar Menu 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 Markdown Sidebar Menu 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 Markdown Sidebar Menu 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 Markdown Sidebar Menu extension in 2 ways. We hope this guide proves helpful.

Similar Extensions

icon

GitHub markdown ToC Extension · Productivity 75 1 ★ 45.48KiB

icon

Table of Contents for GitHub Extension · Developer Tools 75 4 ★ 11.44KiB

icon

github-readme-toc Extension · Developer Tools 75 2 ★ 2.22MiB

icon

Markdown Menu for GitHub Extension · Developer Tools 75 9 ★ 5.8KiB

icon

GitHub submodule links Extension · Developer Tools 75 2 ★ 17.49KiB

icon

Github diff helper Extension · Developer Tools 75 3 ★ 137KiB

icon

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

icon

Github Package.json Enhancer Extension · Developer Tools 75 0 ★ 18.89KiB

icon

Github Markdown Outline Extension Extension · Productivity 75 5 ★ 146KiB

icon

OctoLenses Extension · Developer Tools 75 3 ★ 3.74MiB

icon

Pages2Repo Extension · Productivity 75 3 ★ 213KiB

icon

OctoPermalinker Extension · Developer Tools 75 1 ★ 373KiB

icon

Github Annotator Extension · Developer Tools 75 2 ★ 81.68KiB

icon

Octo Preview Extension · Developer Tools 75 2 ★ 5.16KiB

icon

Github Toc Extension · Developer Tools 75 7 ★ 704KiB

icon

Diff Navigator for GitHub Extension · Developer Tools 75 3 ★ 43.72KiB

icon

GitHub Enhancement Suite Extension · Developer Tools 75 1 ★ 56.24KiB

icon

GitHub Highlight Selected Extension · Developer Tools 75 17 ★ 156KiB

icon

Github Super Search Extension · Developer Tools 75 0 ★ 46.74KiB

icon

Builds Tab for Github Extension · Developer Tools 75 0 ★ 160KiB

icon

Package Hub Extension · Developer Tools 75 2 ★ 28.3KiB

icon

GitHub Hovercard Extension · Developer Tools 75 41 ★ 121KiB

icon

GitHub Issue Link Status Extension · Developer Tools 75 12 ★ 629KiB

icon

Enhanced GitHub Extension · Developer Tools 75 59 ★ 47.01KiB

User reviews

icon

Ramon Smits (ID: 000000a55adc792d) Voted 1 ★ - Updated 02/16/2021 Unfortunately this is not working.

icon

王一平 (ID: 000000473ea32179) Voted 2 ★ - Updated 11/18/2017 it is not work in my chrome...