From 2ac0edb68e675a93575c60a0481a768a4f8a64ba Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=C3=81rni=20Dagur?= Date: Sun, 21 Jun 2020 01:42:35 -0400 Subject: [PATCH] Improve brave adblock documentation in configdata.yml --- qutebrowser/config/configdata.yml | 12 +++++++++++- 1 file changed, 11 insertions(+), 1 deletion(-) diff --git a/qutebrowser/config/configdata.yml b/qutebrowser/config/configdata.yml index 686a7a7ab..7f214181d 100644 --- a/qutebrowser/config/configdata.yml +++ b/qutebrowser/config/configdata.yml @@ -574,7 +574,11 @@ content.blocking.adblock.enabled: default: true supports_pattern: true type: Bool - desc: Enable Brave AdBlock. + desc: >- + Enable Adblock Plus syntax adblock lists using Brave Browsers's adblocking + library. This feature requires the "adblock" Python package, which is an + optional dependency of qutebrowser. It can be installed using the command + `pip install --user adblock`. content.blocking.adblock.lists: default: @@ -597,6 +601,12 @@ content.blocking.whitelist: A list of patterns that should always be loaded, despite being ad-blocked. Local domains are always exempt from adblocking. + Note this whitelists otherwise blocked requests, not first-party URLs. As + an example, if `example.org` loads an ad from `ads.example.org`, the + whitelist entry could be `https://ads.example.org/*`. If you want to disable the + adblocker on a given page, use the `content.host_blocking.enabled` setting + with a URL pattern instead. + content.hyperlink_auditing: default: false type: Bool