Nocturnally Psychologizing Millipede

    darkreader

    4.9.39 • Public • Published

    Dark Reader's mascot

    Dark Reader analyzes web pages and aims to reduce the eyestrain while you browse 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 that is designed to analyze web pages. Based on its analysis, Dark Reader will generate a dark mode that aims to reduce the eyestrain of the user. Dark Reader is feature-rich and can be configured 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 terminal in the root folder and run:

    • npm install
    • npm run build

    This will generate a build/release/darkreader-chrome.zip file that is useable in a Chromium-based browser and also a build/release/darkreader-firefox.xpi file that is useable 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();

    Site fixes

    Automatically syncing the site fixes to every Dark Reader user was disabled because the GitHub team doesn't allow using GitHub as a CDN. Storing these files and making requests to other resources would be expensive and look suspicious. As such, changes are included with each new Dark Reader release.

    However, this can be enabled by 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


    Dark Reader exists thanks to all the people who have contributed to Dark Reader!



    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. By supporting this project, it will allow the maintainers to dedicate more time for maintenance and 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 our wonderful sponsors!

    Install

    npm i darkreader

    DownloadsWeekly Downloads

    9,869

    Version

    4.9.39

    License

    MIT

    Unpacked Size

    245 kB

    Total Files

    5

    Last publish

    Collaborators

    • alexanderby