Skip to content

Latest commit

 

History

History
72 lines (55 loc) · 4.22 KB

README.md

File metadata and controls

72 lines (55 loc) · 4.22 KB
Raw

Darkness: Dark Themes for Popular Websites

Darkness Logo

Darkness is a browser extension for Chrome and Firefox that provides dark themes for many popular websites, such as Google, Facebook, Gmail and YouTube.

Using dark themes reduces the eye strain and fatigue caused by a bright screen, helps you sleep faster and better at night, and generally makes you awesome!

Pull requests are welcome! Help us improve Darkness by contributing fixes and new themes

Major contributors (10+ commits): Lior Grossman, Theis Villumsen, Nicolas Botello, Derek Bytheway, Matt Tayler

Screenshot

Features

  • Supports over 25 websites: Google, Facebook, YouTube, Gmail, Google Drive, Twitter, Facebook Messenger, Instagram, Reddit, Google Keep, Google Photos, Google Calendar, Dropbox, Quora, GitHub, StackOverflow, Trello, JSFiddle and others (help us add more)
  • Select from 7 dark color themes: Iceberg, Tomorrow, Material, Dusk, Red Alert, Coffee, Matrix (help us add more)
  • Written in JavaScript, uses SASS
  • Self-hosted. Easy to install on Windows, Mac, Linux
  • Also available on Chrome Web Store and Firefox Add-on Store

Installation

Installing Darkness Developer Edition:

  1. Fork the Darkness repository: https://github.com/liorgrossman/darkness/fork
  2. Clone the fork on your machine:
    • If you use SSH: git clone [email protected]:YOUR_GITHUB_USER/darkness.git
    • If you use HTTPS: git clone https://github.com/YOUR_GITHUB_USER/darkness.git
  3. Go to the Darkness root directory: cd darkness
  4. Add the original repository as a remote:
    • If you use SSH: git remote add upstream [email protected]:liorgrossman/darkness.git
    • If you use HTTPS: git remote add upstream https://github.com/liorgrossman/darkness.git
  5. Fetch the code: git fetch upstream
  6. Run npm install from the same directory as package.json to install dependencies and compile all SCSS to CSS (Node.js required)

Loading it in Chrome:

  1. Open Chrome and browse to chrome://extensions
  2. If you've previously installed Darkness from Chrome Web Store, disable it
  3. Check Developer mode in the top of the Extensions page
  4. Click Load unpacked
  5. Choose the sub-directory darkness/chrome-extension (where manifest.json resides)

Loading it in Firefox:

  1. Run gulp ff to replicate and transform the chrome-extension directory to firefox-extension
  2. Open Firefox and browse to about:debugging
  3. If you've previously installed Darkness from Firefox Add-on store, disable it
  4. Click Load Temporary Add-on
  5. Choose the file darkness/firefox-extension/manifest.json

To keep Darkness up-to-date, please pull occasionally:

git checkout master
git pull upstream master
npm install
Firefox version only: gulp ff

Contributing fixes and new themes

Pull requests are welcome! Please see our contribution guide to learn how to quickly improve and extend Darkness

Be in touch

Misc

Darkness is licensed GPLv3. Privacy policy available here