aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
blob: ee43bb0a5273f56df627cc845ec45d6c316198da (plain)
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
Legibility
==========

A WebExtension that enables you to add custom CSS styles to websites. Unlike a
global user stylesheet, this extension loads a separate stylesheet for each
site, giving you control over the appearance of any site. For example, sites
with poorly legible typography can be easily corrected for better a reading
experience.


## Usage
Let’s say we want to modify the font of an article on `www.example.com`. Add an
`www.example.com.css` file in the extension’s `css/` directory:

``` css
/* legibility/css/www.example.com.css */
article {
	font: 18px/1.7em Georgia !important;
}
```

Upon reloading the page, the custom stylesheet should now be applied.

Stylesheets must use a filename matching the website’s domain (including
subdomains), and terminated by a `.css` extension.


## Install
This extension should be installed unpacked to allow you to freely add and
modify stylesheets in the `css/` directory.


### Chrome
Begin by cloning this repository. Open the Extensions page
(`chrome://extensions/`) and click the “Load unpacked” button. In the resulting
file browser, select the extension’s directory.


### Firefox
This extension is unsigned. Refer to “What are my options if I want to install
unsigned extensions in Firefox?” in
https://wiki.mozilla.org/Add-ons/Extension_Signing#FAQ before attempting to
install it.

	cd '~/Library/Application Support/Firefox/Profiles/PROFILE_DIRECTORY/extensions'
	git clone https://github.com/teddywing/Legibility.git 'com.teddywing@legibility'

Relaunch Firefox and open the Add-ons page (`about:addons`). Click the “Enable”
button on Legibility’s row.


## License
Copyright © 2018 Teddy Wing. Licensed under the GNU GPLv3+ (see the included
COPYING file).