Thanks to visit codestin.com
Credit goes to Github.com

Skip to content

ferblape/readme-toc

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

6 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

GitHub README TOC Extension

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.

Features

  • 📑 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

Installation

  1. Clone this repository or download the ZIP file
  2. Open Chrome and navigate to chrome://extensions/
  3. Enable "Developer mode" in the top right corner
  4. Click "Load unpacked" and select the extension directory

Usage

  1. Navigate to any GitHub repository's README page
  2. The table of contents will automatically appear on the left side of the screen
  3. Click on any heading in the TOC to jump to that section
  4. The TOC remains visible while scrolling for easy navigation

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

  1. Fork the repository
  2. Create your feature branch (git checkout -b feature/AmazingFeature)
  3. Commit your changes (git commit -m 'Add some AmazingFeature')
  4. Push to the branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

License

This project is licensed under the MIT License - see the LICENSE file for details.

Screenshots

Screenshot 2025-02-03 at 12 13 45

Icons

Icons from Flaticon

Author

Fernando Blat - [https://github.com/ferblape]

Acknowledgments

  • Thanks to the GitHub community
  • Inspired by the need for better documentation navigation

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published