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

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