/github-markdown-toc

Chrome extension to show a table of contents of markdown on GitHub

Primary LanguageTypeScriptCreative Commons Zero v1.0 UniversalCC0-1.0

GitHub Markdown Table of Contents

CAUTION: This project is no longer in development since GitHub officially supports the table of contents in Markdown files.

GitHub Workflow Status Codecov GitHub release CC0-1.0 JavaScript Standard Style styled with prettier

Chrome extension to show a table of contents on GitHub.
No more scrolling to read long long long documents.

this app on GitHub
An example of a long readme with this extension -- AVA: a nice test runner for Node.js

Works with:

  • README on the top pages
  • Markdown files
  • Wikis
  • Commented tags in release pages

Install

You can install the latest version manually.

To install it, follow these steps:

  1. Download github-markdown-toc.zip from the release page and unzip it.
  2. Visit chrome://extensions.
  3. Click to check Developer mode.
  4. Click Load unpacked extension....
  5. In the file-selection dialog, select the unzipped directory.

For more information, see Chrome Extension Get Started or Google Chrome FAQ.

Usage

To show or hide the table of contents, click the button on the top right-hand corner.
When a table of contents is not generated, the button is disabled.

the button when logging in

Permissions

"permissions": [
  "https://github.com/*"
]
  • https://github.com/* is used to run scripts on GitHub.

Recommended environment

  • the latest stable version of Google Chrome

License

CC0
CC0