Newton's Poleless Magnet

    darkreader

    4.9.57 • Public • Published

    Dark Reader's mascot

    Dark Reader analyzes web pages and aims to reduce eyestrain while browsing the web.


    Chrome Web Store Firefox Add-ons Apple App Store Edge Addons Thunderbird

    Dark Reader


    Dark Reader is an open-source MIT-licensed browser extension designed to analyze web pages. Dark Reader will generate a dark mode that aims to reduce the eyestrain of the user. Dark Reader is feature-rich and is customizable in many ways throughout the UI.



    Questions

    Most questions can be answered by reading the help page. If the help page doesn't answer your question, open up a new discussion.

    How to contribute

    Read more about contributing to Dark Reader in CONTRIBUTING.md.

    Building for use

    You can install the extension from a file.
    Install Node.js LTS. Download the source code (or check out from git).
    Open the terminal in the root folder and run:

    • npm install
    • npm run build

    This will create a build/release/darkreader-chrome.zip file for use in a Chromium-based browser and a build/release/darkreader-firefox.xpi file for use in Firefox.

    Using Dark Reader for a website

    You can use Dark Reader to enable dark mode on your website!

    • Install the package from NPM (npm install darkreader)
    • or build from the source code (npm run api)
    • or include the script via a CDN such as unpkg or jsDelivr

    Then you can use the following code to control Dark Reader's API

    DarkReader.enable({
        brightness: 100,
        contrast: 90,
        sepia: 10
    });
    
    DarkReader.disable();
    
    // Enable when the system color scheme is dark.
    DarkReader.auto({
        brightness: 100,
        contrast: 90,
        sepia: 10
    });
    
    // Stop watching for the system color scheme.
    DarkReader.auto(false);
    
    // Get the generated CSS of Dark Reader returned as a string.
    const CSS = await DarkReader.exportGeneratedCSS();
    
    // Check if Dark Reader is enabled.
    const isEnabled = DarkReader.isEnabled();

    ... or if you are using ES modules

    import {
        enable as enableDarkMode,
        disable as disableDarkMode,
        auto as followSystemColorScheme,
        exportGeneratedCSS as collectCSS,
        isEnabled as isDarkReaderEnabled
    } from 'darkreader';
    
    enableDarkMode({
        brightness: 100,
        contrast: 90,
        sepia: 10,
    });
    
    disableDarkMode();
    
    followSystemColorScheme();
    
    const CSS = await collectCSS();
    
    const isEnabled = isDarkReaderEnabled();

    Be aware that darkreader will add the chrome object onto the window object. These are to stub certain functions that the code will use. They originate from the webextension-api.

    Site fixes

    Automatically syncing the site fixes to every Dark Reader user was disabled because the GitHub team does not allow using GitHub as a CDN. The storage of these files would be expensive, and making requests to other resources would look suspicious. Each new release of Dark Reader will include these changes.

    However, this can be enabled using the following steps:

    • Click on the Dark Reader icon.
    • Click on the Dev tools button (in the bottom-right corner).
    • Click on the Preview new design button.
    • Enable the Synchronize site fixes setting under Settings -> Manage Settings.

    Contributors


    Thank you to all our contributors! Dark Reader exists thanks to you.



    Backers


    Thank you to all our generous backers! Support Dark Reader by becoming a backer.



    Sponsors

    Does your company use Dark Reader? Ask your manager or the marketing team if your company would be interested in supporting our project. Your support will allow the maintainers to dedicate more time to maintenance and creating new features for everyone. Also, your company's logo will show on GitHub. Who doesn't want a little extra exposure? Here's the info.

    Thank you to all our wonderful sponsors!



    Install

    npm i darkreader

    DownloadsWeekly Downloads

    19,744

    Version

    4.9.57

    License

    MIT

    Unpacked Size

    256 kB

    Total Files

    5

    Last publish

    Collaborators

    • alexanderby