Adds a navigation menu to any readme or Markdown file on GitHub.

Latest Version

Version
1.1.0
Update
August 9, 2018
Size
5.8KiB
Developer
Category
Users
893
Rating
4.77778 ★
Manifest Version
2
Web Store Status
Languages Support
English
See more
Permissions
Https://github.com/*/*
WebNavigation
See more

Markdown Menu for GitHub Extension

Independently developed and unaffiliated with GitHub.

This extension is open source: https://github.com/willklein/markdown-menu

---

GitHub READMEs and Markdown 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.

Click the three-bar icon at the top of any Markdown file to view the menu. 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.
Read more

Source Manifest.json

{"update_url": "https://clients2.google.com/service/update2/crx", "name": "__MSG_appName__", "version": "1.1.0", "manifest_version": 2, "description": "__MSG_appDescription__", "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 Markdown Menu for GitHub extension for Chrome

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

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

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

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

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

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

Similar Extensions

icon

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

icon

GitHub Markdown Sidebar Menu Extension · Developer Tools 893 2 ★ 8.44KiB

icon

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

icon

Github Toc Extension · Developer Tools 893 7 ★ 704KiB

icon

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

icon

Sourcegraph Extension · Developer Tools 893 169 ★ 8.22MiB

icon

Package Hub Extension · Developer Tools 893 2 ★ 28.3KiB

icon

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

icon

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

icon

github npm stats Extension · Developer Tools 893 4 ★ 65.86KiB

icon

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

icon

GitHub Hovercard Extension · Developer Tools 893 41 ★ 121KiB

icon

Enhanced GitHub Extension · Developer Tools 893 59 ★ 47.01KiB

icon

GitHub Code Folding Extension · Developer Tools 893 16 ★ 1.06MiB

icon

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

icon

GitHub Repository Size Extension · Developer Tools 893 80 ★ 12.9KiB

icon

OctoLinker Extension · Developer Tools 893 110 ★ 184KiB

icon

Widescreen for GitHub Extension · Developer Tools 893 24 ★ 1.94MiB

icon

Octotree - GitHub code tree Extension · Developer Tools 893 1139 ★ 3.54MiB

icon

GitHub File Icons Extension · Developer Tools 893 8 ★ 435KiB

icon

github.expandinizr Extension · Developer Tools 893 29 ★ 68.69KiB

icon

Markdown Cheatsheet Extension · Developer Tools 893 8 ★ 79.84KiB

icon

GitHub Isometric Contributions Extension · Developer Tools 893 102 ★ 101KiB

icon

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

User reviews

icon

彭凌峰 (ID: 000000d2163c5344) Voted 3 ★ - Updated 10/05/2018 if file too large ,i always roll to top to read the menu ,menu button id weather to have settings to have a absolute position,and a wider frame

icon

Sean Peltier (ID: 000000b82cd33bb0) Voted 5 ★ - Updated 08/10/2018 I absolutely love this extension. It is very user friendly and easy to use. Thanks!

icon

Angus Liu (ID: 000000fb99de7fde) Voted 5 ★ - Updated 06/29/2018 Perfect!

icon

Ze Ye (ID: 00000032cc942f00) Voted 5 ★ - Updated 08/17/2016 helpful extension! thx

icon

Roman Gromov (ID: 00000053d9df2181) Voted 5 ★ - Updated 04/18/2015 great! must have this feature