Markdown Menu for GitHub

#4.78 / 9 rate

Markdown Menu for GitHub

1,000 users

2018-08-09

Will Klein

Extension Information

5 star
83%
4 star
0%
3 star
17%
2 star
0%
1 star
0%

Supported Languages

Permissions

Description

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

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.

Reviews

彭凌峰
彭凌峰

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

Sean Peltier
Sean Peltier

I absolutely love this extension. It is very user friendly and easy to use. Thanks!

Angus Liu
Angus Liu

Perfect!

Similar extensions

GitZip for github
GitZip for github

https://gitzip.org

Le Git Graph - Commits Graph for GitHub
Le Git Graph - Commits Graph for GitHub

https://scaria.dev

Dashboard filter for GitHub
Dashboard filter for GitHub

Mu-An Chiou

Markdown Editor
Markdown Editor

chenzhiwei