Skip to content

browser extension that improves readability and navigation on GitHub repository pages by visually highlighting file and diff tabs based on their indentation level

License

Notifications You must be signed in to change notification settings

nihaltp/tab-highlighter

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

31 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

Tab Highlighter Star on GitHub

A cross-browser extension for Chrome and Firefox that highlights GitHub repository tabs with custom colors and indent levels, enhancing code readability and navigation.

🦊 Available on Firefox Add-ons with automatic updates. Firefox Add-on

✨ Available on Microsoft Edge Addons. Microsoft Edge Version

🌐 Chrome support via GitHub Releases.

License: MIT Open Issues Pull Requests Latest Release

πŸ“š Table of Contents

Features

  • 🌐 Works on both Chrome and Firefox
  • ⚑ Lightweight and fast
  • πŸ’Ύ Persistent tab highlighting
  • 🎯 Easy-to-use popup interface
  • 🎨 Customizable indent levels
  • 🎨 Highlight tabs with custom colors
  • πŸ”§Consider files indent level while highlighting

Installation & Usage

Firefox (Recommended)

The extension is officially published on Firefox Add-ons (AMO).

πŸ‘‰ Install from Firefox Add-ons:

Get the add-on

This provides automatic updates and does not require Developer Mode.

Edge (Recommended)

The extension is officially published on Microsoft Edge Addons.

πŸ‘‰ Install from Microsoft Edge Addons:

Get the add-on

Manual Installation

Pre-built extension packages are available on the GitHub Releases page. This is the easiest way to install the extension β€” no build step required.

πŸ‘‰ Download the latest release: https://github.com/nihaltp/tab-highlighter/releases/latest

Each release includes:

  • tab-highlighter-chrome.zip β€” for Chrome / Chromium browsers
  • tab-highlighter-firefox.zip β€” for Firefox

Chrome / Chromium

  1. Download tab-highlighter-chrome.zip
  2. Extract the ZIP
  3. Open chrome://extensions/
  4. Enable Developer mode
  5. Click Load unpacked
  6. Select the extracted folder

Firefox (manual)

⚠️ Manual installation is intended for testing and development.

For daily use, installing from Firefox Add-ons is strongly recommended.

  1. Download tab-highlighter-firefox.zip
  2. Open about:addons
  3. Click the βš™οΈ menu β†’ Install Add-on From File
  4. Select the ZIP file

Edge (manual)

⚠️ Manual installation is intended for testing and development.

For daily use, installing from Microsoft Edge Addons is strongly recommended.

  1. Download tab-highlighter-edge.zip
  2. Open edge://extensions/
  3. Enable Developer mode
  4. Click Load unpacked
  5. Select the extracted folder

Using the Extension

Go to any GitHub repository file page (e.g. browsing files in a repo). Tabs will be highlighted automatically.

Contributing

Contributions are welcome! Bug fixes, feature suggestions, and pull requests are appreciated. For major changes, please open an issue first to discuss your ideas.

Project Structure

tab_highlighter/
β”œβ”€β”€ .github/
β”‚   └── workflows/
β”‚       └── build.yml          # GitHub Actions workflow for building the extension
β”‚
β”œβ”€β”€ .husky/
β”‚   └── pre-commit             # Pre-commit hook for linting and formatting
β”‚
β”œβ”€β”€ dist/                      # Compiled output
β”‚
β”œβ”€β”€ icons/                     # Extension icons
β”‚
β”œβ”€β”€ manifests/
β”‚   β”œβ”€β”€ manifest.chrome.json   # Chrome extension manifest (Manifest V3)
β”‚   β”œβ”€β”€ manifest.firefox.json  # Firefox extension manifest (Manifest V3)
β”‚   └── manifest.edge.json     # Edge extension manifest (Manifest V3)
β”‚
β”œβ”€β”€ node_modules/              # Project dependencies
β”‚
β”œβ”€β”€ scripts/
β”‚   β”œβ”€β”€ build.js               # Build script
β”‚   └── update-manifests.js    # Script to update manifest files
β”‚
β”œβ”€β”€ src/
β”‚   β”œβ”€β”€ content/
β”‚   β”‚   β”œβ”€β”€ content.js             # Content script injected into pages
β”‚   β”‚   └── content.css            # Content styling
β”‚   └── popup/
β”‚       β”œβ”€β”€ popup.css              # Popup styling
β”‚       β”œβ”€β”€ popup.html             # Popup HTML
β”‚       └── popup.js               # Popup JavaScript
β”‚
β”œβ”€β”€ .gitignore                 # Git ignore rules
β”œβ”€β”€ .prettierrc                # Prettier configuration for consistent formatting
β”œβ”€β”€ LICENSE                    # MIT License
β”œβ”€β”€ package-lock.json          # Locked dependency versions
β”œβ”€β”€ package.json               # Project dependencies and scripts
└── README.md

For Developers

Prerequisites

  • npm

Setup

  1. Clone the repository:
git clone https://github.com/nihaltp/tab-highlighter.git
cd tab-highlighter
  1. Install dependencies:
npm install

Building (For Developers)

Build for Chrome

npm run build:chrome

The packaged extension will be in dist/chrome/.

Build for Firefox

npm run build:firefox

The packaged extension will be in dist/firefox/.

Loading the Extension

Chrome

  1. Open chrome://extensions/
  2. Enable "Developer mode" (toggle in top right)
  3. Click "Load unpacked"
  4. Navigate to dist/chrome/ and select it
  5. The extension will be loaded and ready to use

Firefox

  1. Open about:debugging#/runtime/this-firefox
  2. Click "Load Temporary Add-on"
  3. Navigate to dist/firefox/manifest.json and select it
  4. The extension will be loaded and ready to use

Edge

  1. Open edge://extensions/
  2. Enable "Developer mode" (toggle in bottom left)
  3. Click "Load unpacked"
  4. Navigate to dist/edge/ and select it
  5. The extension will be loaded and ready to use

Manifest Files

  • manifest.chrome.json: Chrome-specific configuration
  • manifest.firefox.json: Firefox-specific configuration
  • manifest.edge.json: Edge-specific configuration

Roadmap

  • Allow users to set custom colors for different file types
  • Consider files' indent levels while highlighting tabs
  • Chrome Web Store publishing

License

MIT License - see LICENSE file for details

About

browser extension that improves readability and navigation on GitHub repository pages by visually highlighting file and diff tabs based on their indentation level

Topics

Resources

License

Stars

Watchers

Forks