quilljou / github-toc

:book: Browser extension that adds a table of contents to GitHub repos, wikis and gists.

Table of Contents for GitHub

Browser extension that adds a table of contents to repositories, gists and wikis.

Available for Google Chrome, Firefox, Safari and as userscript.

This is a simple browser extension that makes reading long files and pages on GitHub easier. If you regurlarly scroll around readmes and wikis looking for specific information, this is for you. Find what you are looking for, quickly.

Works almost anywhere on GitHub.

• Works with files in repos, gists, and wikis
• Supports any GitHub markup
• Supports editing and creating files and wiki pages directly on GitHub
• It's simple and unobtrusive

Install

❤️ Chrome (Chrome Web Store)

💚 Firefox (Mozilla Add-Ons)

💙 Safari

💜 Userscript

Note on Safari: The Safari extension is not (yet) hosted on Apple's Extension Gallery. To install, download the extension safari.safariextz from the dist folder and open it. Since the extension is not from the Gallery, Safari will ask you to trust it.

Build

npm run install
npm run build

See building for more.

Contribute

Contributions are welcome! 👍😀

Changelog

See CHANGELOG.

License

MIT.