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

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...