DarkReader for Google Chrome

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 fix_inversion.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.

Using Dev Tools

• Open Chrome Dev Tools (F12).
• Click on element picker (top-left corner).
• Pick wrongly inverted element.
• Choose a selector for that element or all similar elements (e.g. if element has class="x-icon small" selector may look like .x-icon).
• Click Dark Reader icon.
• Click Open developer tools (at bottom).
• Under sites section add a block containing URL and selectors to invert.

...
"sites": [
    {
        "url": "example.com",
        "invert": ".x-icon"
    }
]

• It is also possible to specify multiple selectors (comma-separated list or an array) and custom CSS rules. If chosen element contains images or other content that becomes wrongly displayed, noinvert rule can be used. removebg removes background image from element.

...
"sites": [
    {
        "url": "example.com",
        "invert": [
            ".x-icon, .x-button",
            "#player .player-button"
        ],
        "noinvert": "#player *",
        "removebg": ".bg-photo",
        "rules": ".overlay { background: rgba(255,255,255,0.5); }"
    }
]

• Click Apply.
• If the fix worked open fix_inversion.json file.
• Click edit (sign-in to GitHub first).
• Insert your fix there. Preserve alphabetical order by URL, use 4 spaces for indentation.
• Provide a short description of what you have done.
• Click Propose file change.
• Review your changes. Click Create pull request.
• The Travis CI will run tests reviewing your changes.
• If you see a red cross click Details and see what is wrong.
• When you see a green checkmark than everything is fine.
• Dark Reader developer will review and merge your changes making them available for all users.

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!