Skip to content

N1ck/gifs-for-github

Repository files navigation

GIFs for GitHub

A Browser extension that makes it easy to search and add a GIF into any GitHub comment box.

Example image


Install

Chrome

Firefox


Options

Collapsible GIFs

Right-click the extension icon and select Use collapsible GIFs to wrap GIFs in a <details> block instead of embedding them inline.

Right-click menu showing Use collapsible GIFs option

Collapsible GIF in action

GitHub Enterprise

Right-click the extension icon on your GitHub Enterprise domain and select Enable GIFs for GitHub on this domain to enable the extension there.

Right-click menu showing Enable GIFs for GitHub on this domain option

GIPHY API Key

By default the extension uses KLIPY as its GIF provider. If you have your own GIPHY API key and would like to use GIPHY instead, open the extension's options page and paste your key there.

  • Chrome: chrome://extensions → GIFs for GitHub → Details → Extension options
  • Firefox: about:addons → GIFs for GitHub → Preferences

Right-click menu showing extension options (Chrome)

Right-click menu showing extension options (Firefox)

Options page with GIPHY API key input


Contributing

git clone https://github.com/N1ck/gifs-for-github
cd gifs-for-github
pnpm install
pnpm run build   # Output goes to distribution/
pnpm run watch   # Rebuild on file changes

Project layout

Path Purpose
src/ Extension source (loaded by webpack)
distribution/ Build output (gitignored; load this in the browser)
assets/ Screenshots and GIFs for this README
designs/ Logo source files (Sketch)

Debug Mode

When developing, you can enable debug mode by setting the DEBUG environment variable:

DEBUG=true pnpm run build

This will output helpful logs prefixed with 🎨 when using the extension.

Once built, load it in the browser of your choice with web-ext:

npx web-ext run --target=chromium # Open extension in Chrome
npx web-ext run # Open extension in Firefox

Or you can load it manually in Chrome or Firefox.


If you want to read about why I built this extension, and some of the challenges I faced, check out my blog post.

Sponsor this project

Packages

 
 
 

Contributors