-
Notifications
You must be signed in to change notification settings - Fork 10
Expand file tree
/
Copy pathindex.html
More file actions
164 lines (143 loc) · 8.8 KB
/
index.html
File metadata and controls
164 lines (143 loc) · 8.8 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8" />
<title>Help – Dark Reader</title>
<meta name="viewport" content="width=device-width, initial-scale=1" />
<link rel="shortcut icon" href="/images/darkreader-icon-256x256.png" />
<link rel="stylesheet" type="text/css" href="/styles/help-topic.css" />
<meta name="theme-color" content="#141e24" />
<meta property="og:type" content="article" />
<meta property="og:url" content="https://darkreader.org/help/en/" />
<meta property="og:title" content="Help – Dark Reader" />
<meta property="og:image" content="https://darkreader.org/images/darkreader-preview-medium.png" />
</head>
<body class="page-grid-body">
<header class="page-grid-header">
<a class="help-header-logo" href="../"></a>
</header>
<article class="page-grid-content">
<p>This document will guide you through Dark Reader features.</p>
<ul>
<li><a href="#faq">FAQ</a></li>
<li><a href="#contacts">Contacts</a></li>
<li><a href="#top-section">Top section</a></li>
<li><a href="#filter-settings">Filter settings</a></li>
<li><a href="#custom-site-settings">Custom site settings</a></li>
<li><a href="#site-list">Site list</a></li>
<li><a href="#more-tab">More tab</a></li>
<li><a href="#theme-generation-modes">Theme generation modes</a></li>
<li><a href="#bottom-section">Bottom section</a></li>
<li><a href="#using-dev-tools">Using the Developer tools</a></li>
</ul>
<h2 id="top-section">Top section</h2>
<img src="/images/help/darkreader-top-section.png" alt="Top section" style="width: 15rem;" />
<ul>
<li><strong>Toggle site</strong> button adds current site into ignore list (or removes from there).</li>
<li><strong>On/Off</strong> switch enables or disables the extension.</li>
<li>Click on the links under the buttons to <strong>modify hotkeys</strong>.</li>
<li>If the toggle button is greyed-out, it means that browser restricts injecting scripts into current page.</li>
</ul>
<h2 id="filter-settings">Filter settings</h2>
<img src="/images/help/darkreader-filter-settings.png" alt="Filter settings" style="width: 15rem;" />
<p>Adjust the filter values, that better fit your screen parameters and lighting in the room.</p>
<h2 id="custom-site-settings">Custom site settings</h2>
<img src="/images/help/darkreader-custom-site-settings.png" alt="Custom settings" style="width: 15rem;" />
<p><strong>Only for</strong> button makes settings to be applied to the current website only.</p>
<p>Click the button, adjust the settings, click again to cancel.</p>
<h2 id="site-list">Site list</h2>
<img src="/images/help/darkreader-site-list.png" alt="Site list" style="width: 15rem;" />
<ul>
<li>Use <strong>Invert listed only</strong> if you wish Dark Reader to work only on listed websites.</li>
<li><strong>Not invert listed</strong> will prevent the extension from working on listed websites.</li>
<li>Possible values are <code>google.com, mail.google.com, google.*, google.com/maps</code> etc.</li>
<li>Clicking on <strong>Toggle</strong> button adds site into this list.</li>
</ul>
<h2 id="more-tab">More tab</h2>
<img src="/images/help/darkreader-more-tab.png" alt="More tab" style="width: 15rem;" />
<ul>
<li><strong>Pick a font</strong> from list (or enter font name on Firefox), click the <strong>checkbox</strong>.</li>
<li>Adjust the <strong>text stroke</strong>.</li>
<li>Choose a <strong>theme generation mode</strong>.</li>
</ul>
<h2 id="theme-generation-modes">Theme generation modes</h2>
<figure>
<img src="/images/help/darkreader-theme-modes.png" alt="Filter+ vs. Static vs. Dynamic mode" />
<figcaption>Filter+ vs. Static vs. Dynamic mode</figcaption>
</figure>
<ul>
<li><strong>Filter</strong> is initial Dark Reader mode based on CSS filters.
It <strong>inverts the whole page</strong> and <strong>reverts some parts</strong> back.
Requires GPU resources.</li>
<li>*Fast** and powerful, but has several issues:
disables text sub-pixel rendering,
inverts already dark parts into light,
causes lags on large pages,
fails to render some pages in Firefox.</li>
<li><strong>Filter+</strong> it the same as Filter, but is based on custom SVG filters
and <strong>handles colors better</strong> making images less dull.
Works bad in Firefox.</li>
<li><strong>Static</strong> rapidly generates a basic stylesheet.</li>
<li><strong>Dynamic</strong> deeply analyzes website stylesheets, background images, vector graphics.
Requires some resources on initial page load,
but produces <strong>the best</strong> visual results.
The work on this mode is in progress,
but it already works well for many modern websites.</li>
</ul>
<h2 id="bottom-section">Bottom section</h2>
<img src="/images/help/darkreader-footer.png" alt="Bottom section" style="width: 15rem;" />
<ul>
<li>Read our <strong>privacy policy</strong>, follow us on <strong>Twitter</strong>.</li>
<li><strong>Donate</strong> – if you like the extension, consider supporting the active Dark Reader development.
Crowdfunding is held by Open Collective, which uses Stripe at the moment for processing payments.</li>
<li><strong>News</strong> – notifies about release notes and important events.</li>
<li><strong>Developer tools</strong> – opens a config editor for the current theme mode.</li>
</ul>
<h2 id="using-dev-tools">Using the Developer tools</h2>
<p>If you are familiar with CSS selectors, you can suggest a fix for some websites.
Read how to use the developer tools <a href="https://github.com/darkreader/darkreader#how-to-contribute">here</a>.</p>
<h2 id="faq">FAQ</h2>
<h4 id="the-extension-asks-for-permissions-to-read-website-data">The extension asks for permissions to read website data</h4>
<p>The extension needs these permissions to be able to analyze and modify website appearance,
determine if a website is disabled by your settings or use site-specific rules.
We do not insert ads and do not collect any data or send it anywhere.
The extension is fully open-source and has no obfuscated code.
Our monetization is transparent and is based on user's donations.</p>
<h4 id="extensions-store-page-and-settings-pages-remain-white">Extensions' store page and settings pages remain white</h4>
<p>The extension has no access to these pages.</p>
<h4 id="new-tab-page-and-browser-theme-remain-white">New tab page and browser theme remain white</h4>
<p>The extension cannot change the appearance of a new tab or browser (it can since Firefox 60).
Install some dark theme or new tab extension from extensions store.</p>
<h4 id="screen-flashes-white-when-opening-a-new-tab-or-navigating-a-website">Screen flashes white when opening a new tab or navigating a website</h4>
<p>Before loading a website, Chrome shows theme background color by default,
so you should install some dark theme from the store.</p>
<h4 id="the-extension-doesnt-work-at-all">The extension doesn't work at all</h4>
<p>If you have similar dark mode extensions installed, disable them, reload tabs.
Click Dark Reader icon, check if top-right button is set to <strong>On</strong>.
Open <strong>Site list</strong> tab, check that <strong>Not invert listed</strong> is selected.
If nothing helps, something terrible has happened, e-mail us.</p>
<h4 id="the-website-is-displayed-incorrectly-or-works-slow">The website is displayed incorrectly or works slow</h4>
<p>Please, send the website address, screenshot, your OS and browser versions to our e-mail.
We will try to investigate the reason, at least for a popular website.
Also try changing <strong>theme generation mode</strong> or try using <strong>Light mode</strong>.
Check that website is not listed under <strong>Site list</strong> tab.</p>
<h4 id="the-extension-doesnt-work-in-incognito-mode">The extension doesn't work in incognito mode</h4>
<p>Open <strong>chrome://extensions</strong> page, find <strong>Dark Reader</strong>, click <strong>Allow in incognito</strong>.</p>
<h4 id="the-extension-doesnt-work-for-local-files">The extension doesn't work for local files</h4>
<p>Open <strong>chrome://extensions</strong> page, find <strong>Dark Reader</strong>, click <strong>Allow access to file URLs</strong>.</p>
<h4 id="entire-website-is-not-displayed-in-filter-mode">Entire website is not displayed in Filter mode</h4>
<p>If you are using Chrome for Mac OS, update Mac OS up to 10.13, this should update your video drivers.
If you are using Firefox, this is most likely a browser bug, use another mode for such websites.</p>
<h2 id="contacts">Contacts</h2>
<p>For any questions e-mail to <a href="mailto:darkreaderapp@gmail.com">darkreaderapp@gmail.com</a></p>
</article>
<aside class="page-grid-inside">
<darkreader-backers-header></darkreader-backers-header>
<script type="module" src="/elements/backers-header.js"></script>
</aside>
<aside class="page-grid-side">
<darkreader-backers-side></darkreader-backers-side>
<script type="module" src="/elements/backers-side.js"></script>
</aside>
</body>
</html>