Skip to content

Latest commit

Β 

History

6 Commits

Folders and files

NameName
Last commit message
Last commit date
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

🎨 OCTANE β€” Themes & Zen for GitHub

OCTANE

Restyle GitHub with beautiful themes, custom backgrounds and your own color schemes β€” then declutter the interface so it finally makes sense to newcomers.

A tiny, dependency-free browser extension (Manifest V3) that re-themes GitHub on the fly β€” and this time you're not limited to light and dark.

Theme preview

Want to see it right now? Open docs/demo.html β€” a fully self-contained live preview (also nice for hosting on GitHub Pages).


✨ Features

1. Ten one-click themes (no page reloads)

GitHub ships one light theme and one dark theme. OCTANE ships ten, applied instantly to every open GitHub tab and persisted across restarts:

Theme Vibe Mode
GitHub Light The default, for when you want stock Light
GitHub Dark GitHub's native dark, as a baseline Dark
Paper Warm, soft off-white with indigo accents Light
Midnight Deep navy with electric blue Dark
Nord The beloved arctic palette Dark
Solarized Dark Ethan Schoonover's classic Dark
Nocturne Purple-pink "Dracula-flavored" Dark
Sakura Soft pink pastel β€” with falling petals 🌸 Light
Kin-Beni πŸ†• Japanese vermilion red & gold on sumi black β€” with embers Dark
Cosmos πŸ†• Hollow, glassy deep space β€” with twinkling stars ✨ Dark

2. Your own accent color

Don't like a theme's accent? Pick any color and it overrides links and primary buttons across every preset theme β€” with automatically computed contrast so text stays readable.

3. Custom backgrounds πŸ†•

Put a wallpaper behind your GitHub content:

  • Image β€” upload your own (auto-compressed & saved locally) or paste a URL
  • Gradient β€” two colors + angle, or one of six presets (including a red & gold "Kin-Beni")
  • Solid color β€” flat color of your choice
  • Fade slider β€” how much the wallpaper shows through, so text never becomes unreadable

GitHub's cards stay solid; the wallpaper glows around and behind them.

4. Build any color scheme you want πŸ†•

The Custom tab is a full theme builder: pick a light or dark base, then set page background, cards, text, muted text, borders, accent, primary button and header β€” anything you don't touch is derived automatically. This is the "no more feature requests" feature: if you can think of a color scheme, you can make it.

The Custom tab also has a "Hide horizontal scrollbars" toggle β€” it removes the sideways scrollbar in code blocks and tables (content still scrolls with a trackpad or Shift + wheel).

5. "Simplify" mode for newcomers β€” Signal vs Context vs Noise

Built on a simple philosophy: Signal (code, files, issues, PRs) always stays. Context (languages, contributors, stars) gets dimmed. Noise (promos, popularity, discovery) gets removed.

Level What it does
Gentle Quieter GitHub β€” hides promos, Releases, Packages & Deployments; dims stars, forks and sidebar metadata
Focus A coding workspace β€” hides social & popularity metrics, discovery links and the last-commit row; keeps Code, files, the README and the About box (your profile picture stays)

Focus extras: a small pill shows "N elements hidden" (click it to exit), and Ctrl/Cmd + Shift + F toggles Focus from anywhere.

6. Ambient theme effects

Sakura sheds falling petals, Cosmos has a twinkling starfield, and Nocturne & Kin-Beni glow with rising embers β€” a lightweight canvas that pauses when the tab is hidden. Toggleable in the popup.

7. Glassy navbar

Turn a background on and the top navigation becomes frosted glass (backdrop-blur + translucency), so the whole page feels like one continuous surface.

8. New-user tips banner

An optional friendly bar on repository pages:

Code is the project's files Β· the README explains what it does Β· Star saves it to your list, Fork copies it to your account.

9. Built to survive GitHub's redesigns

Themes are expressed as GitHub's own CSS custom properties (with legacy --color-* aliases mirrored automatically). All DOM work is text/attribute based with multiple fallback selectors and wrapped in error guards, so a GitHub layout change can never crash the extension β€” worst case, one rule stops matching until the next release. SPA navigation (Turbo/pjax) is handled, so themes, backgrounds and simplification re-apply as you click around.


πŸš€ Install (developer mode, 30 seconds)

Works in Chrome, Edge, Brave, Opera, Arc and any Chromium browser. (Firefox supports Manifest V3 too β€” same steps under about:debugging.)

  1. Download / clone this repo
    git clone https://github.com/yourname/octane.git
  2. Open chrome://extensions (Edge: edge://extensions, Brave: brave://extensions)
  3. Toggle Developer mode on (top-right)
  4. Click Load unpacked and select the octane folder
  5. Open any GitHub repo, click the 🎨 icon in your toolbar, and make it yours

No build step. No dependencies.


🧭 Usage

  • Theme β€” click a card; every open GitHub tab restyles instantly.
  • Accent β€” use the picker or type a hex value; Clear falls back to the theme's own accent.
  • Background β€” pick Image / Gradient / Color, then tune it; Fade keeps text readable.
  • Custom β€” pick a base, tweak any colors, hit Use this theme.
  • Simplify β€” Off / Gentle / Focus.
  • New-user tips β€” toggle the "Quick start" bar.
  • Reset all β€” back to defaults.

Settings sync via chrome.storage.sync (and your wallpaper via chrome.storage.local), so they follow your browser profile across machines.


πŸ“ Project structure

octane/
β”œβ”€β”€ manifest.json          # MV3 manifest
β”œβ”€β”€ shared/
β”‚   └── themes.js          # Single source of truth: themes, custom builder, gradients
β”œβ”€β”€ content/
β”‚   └── content.js         # Injects theme + background CSS, simplification, tips
β”œβ”€β”€ popup/
β”‚   β”œβ”€β”€ popup.html         # Popup UI (Theme / Background / Custom tabs)
β”‚   └── popup.js           # Popup logic (reads/writes storage)
β”œβ”€β”€ icons/                 # Extension icons
β”œβ”€β”€ docs/
β”‚   β”œβ”€β”€ demo.html          # Self-contained live demo (host on GitHub Pages)
β”‚   └── themes-preview.png # Theme preview image
β”œβ”€β”€ tools/
β”‚   β”œβ”€β”€ make_assets.py     # Regenerates icons + preview (Python + Pillow)
β”‚   └── make_demo.py       # Rebuilds docs/demo.html from shared/themes.js
β”œβ”€β”€ CHANGELOG.md
└── LICENSE                # MIT

πŸ›£οΈ The whole process (from zero to published)

A. Run it locally

Load the folder as an unpacked extension (see Install above). Make a change β†’ hit the ⟳ reload button on chrome://extensions β†’ refresh GitHub.

B. Add a theme in 60 seconds

Edit shared/themes.js, copy an existing theme object, change the id, name, base and the colors. Done β€” the popup, content script, README preview image and demo all pick it up. Then:

python3 tools/make_assets.py   # regenerate icons + themes-preview.png
python3 tools/make_demo.py     # regenerate docs/demo.html

C. Publish on GitHub

cd octane
gh repo create octane --public --source=. --push

Enable GitHub Pages β†’ set it to main / docs β†’ share the docs/demo.html live preview in your README.

D. Publish to the Chrome Web Store

  1. Zip the folder: zip -r octane.zip octane -x "octane/.git/*" (or grab the pre-built zip)
  2. Go to the Chrome Web Store Developer Dashboard β†’ pay the one-time $5 registration
  3. Add new item β†’ upload the zip β†’ fill in description/screenshots (use docs/themes-preview.png) β†’ submit for review
  4. Same zip works for Edge Add-ons and (with minor tweaks) Firefox AMO

E. Grow it

A good README + live demo + a launch post ("I made GitHub themable β€” 9 themes, custom backgrounds, custom color schemes") is a reliable recipe for stars. Keep themes expressed purely as CSS variables so they never break.


πŸ› οΈ Roadmap

  • Per-repo theme overrides ("this repo always opens in Midnight")
  • GitHub Enterprise / self-hosted instance support
  • Font + code-font options (e.g. JetBrains Mono for the code view)
  • "Zen mode" that hides the README chrome and shows only the file tree
  • Published builds for Chrome Web Store & Firefox AMO
  • Localization of the tips banner

🀝 Contributing

This is a tiny codebase and a great first open-source project to jump into.

  1. Fork & clone, then load the folder as an unpacked extension.
  2. Make your change β€” no build step, just reload the extension.
  3. To add a theme: add an entry to shared/themes.js. That's it.
  4. Open a PR with a screenshot.

Please keep themes expressed purely as CSS variables so they don't break when GitHub ships UI changes.


βš–οΈ License

MIT β€” do whatever you want, just keep the copyright notice.

Disclaimer: OCTANE is an independent community project and is not affiliated with, endorsed by, or sponsored by GitHub, Inc. "GitHub" and the Octocat are trademarks of GitHub, Inc.

About

No description, website, or topics provided.

Resources

Stars

8 stars

Watchers

1 watching

Forks

Releases

Packages

Contributors

Languages