/darkreader

Dark Reader Chrome extension

Primary LanguageJavaScriptMIT LicenseMIT

DarkReader for Google Chrome

Dark Reader screenshot

This extension inverts brightness of web pages and aims to reduce eyestrain while browsing the web. Visit Chrome Web Store for more info.

How to contribute

Fixing wrong inversion

If some site is already dark, you can add it to dark_sites.json file (please, preserve alphabetical order).

If some parts of web-pages are wrongly inverted, you can specify necessary CSS selectors at sites_fixes_v2.json file (please, preserve alphabetical order by URL, use short selectors, preserve whitespace indentation and code style).

Notice that merged changes to these files are automatically delivered to all users within 15 minutes.

Adding new features or fixing bugs

If you would like to add new feature to Dark Reader or fix a bug, submit an issue in GitHub (if there is no existing one), discuss it with active contributors, wait for approvement.

In order to build and debug the extension install the nodejs. Install development dependencies by running npm install in project root folder. Then execute npm run debug. Open the Chrome's extensions page. Enable the Developer mode, press Load unpacked extension button, navigate to project's src/ folder.

After making any code changes the project will be automatically recompiled. If the extension didn't reload automatically it can be reloaded at Extensions page by pressing the Reload (Ctrl+R) hyperlink.

For editing the code you can use any text editor or web IDE (like Visual Studio Code, Atom, WebStorm). Preserve code style (whitespaces etc).

Submit a pull request, wait for review.

Good luck!