A Chrome extension that adds a convenient table of contents navigation to GitHub README files. The extension automatically generates a floating TOC sidebar that makes it easy to navigate through long documentation.
- 📑 Automatically generates table of contents from README headings
- 🔗 Quick navigation through clickable links
- 📌 Fixed positioning for easy access while scrolling
- 💨 Lightweight and performant
- 🎨 Clean, GitHub-style design
- Clone this repository or download the ZIP file
- Open Chrome and navigate to
chrome://extensions/ - Enable "Developer mode" in the top right corner
- Click "Load unpacked" and select the extension directory
- Navigate to any GitHub repository's README page
- The table of contents will automatically appear on the left side of the screen
- Click on any heading in the TOC to jump to that section
- The TOC remains visible while scrolling for easy navigation
Contributions are welcome! Please feel free to submit a Pull Request.
- Fork the repository
- Create your feature branch (
git checkout -b feature/AmazingFeature) - Commit your changes (
git commit -m 'Add some AmazingFeature') - Push to the branch (
git push origin feature/AmazingFeature) - Open a Pull Request
This project is licensed under the MIT License - see the LICENSE file for details.
Icons from Flaticon
Fernando Blat - [https://github.com/ferblape]
- Thanks to the GitHub community
- Inspired by the need for better documentation navigation