README.zh-CN.md

uBlacklist

English

屏蔽指定的网站防止其显示在 Google 以及其他搜索引擎中

Chrome 应用商店 / Firefox 扩展 / App Store (支持 macOS 和 iOS，特别鸣谢 Group-Leafy)

介绍

此扩展可防止您指定的网站出现在 Google 和其他的一些搜索引擎中。

您可以为搜索结果添加规则或点击工具栏图标以屏蔽指定的网站。规则可以通过以下方式指定：匹配模式 (示例： *://*.example.com/*，这样的话会屏蔽 example.org 网站) 或使用正则表达式 (示例： /example\.(net|org)/，这样的话可以屏蔽 example.net 和 example.org 两个网站).

您可以通过云存储跨设备同步规则集。 目前，支持 Google Drive 和 Dropbox。

您还可以订阅公共规则集。 该网站列出了一些订阅：https://iorate.github.io/ublacklist/subscriptions

支持的搜索引擎

此扩展支持以下搜索引擎

	网页	图片	视频	新闻
Google	✔️	✔️	✔️	✔️
Bing	*1	✔️	✔️	✔️
Brave	✔️	✔️	✔️	✔️
DuckDuckGo	✔️	✔️	✔️	✔️
Ecosia	✔️
Qwant	✔️	✔️	*2	✔️
SearX *3	✔️	✔️	✔️	✔️
Startpage	✔️		✔️	✔️
Yahoo! JAPAN	✔️
Yandex	✔️			✔️

*1 仅当 "Always play videos on Qwant.com" 关闭时
*2 仅支持某些公共实例，如果您想将自己的 SearX/SearXNG 添加到支持列表，你需要前往src/common/search-engines.ts，并手动将您的搜索引擎添加到列表中，然后手动进行构建。

发布订阅

要将规则集发布为订阅，请将以 UTF-8 编码的规则集文件放在合适的 HTTP(S) 服务器上，然后发布 URL。 这是托管在 GitHub 上的示例:
https://raw.githubusercontent.com/iorate/ublacklist-example-subscription/master/uBlacklist.txt

在 Chrome 浏览器中且 uBlacklist >=6.6.0 ，订阅链接是有效的。为 name 和 url 添加订阅, 以下 URL 可用作选项页面的快捷方式:

https://iorate.github.io/ublacklist/subscribe?name={urlEncode(name)}&url={urlEncode(url)}

对于上面的示例:
https://iorate.github.io/ublacklist/subscribe?name=Example&url=https%3A%2F%2Fraw.githubusercontent.com%2Fiorate%2Fublacklist-example-subscription%2Fmaster%2FuBlacklist.txt

开发者

构建

为了构建这个扩展，你需要下载并安装 Node.js>=16 和 Yarn。

git clone https://github.com/iorate/ublacklist.git

cd ublacklist

yarn

# yarn build <browser:=chrome-mv3> <mode:=development>
yarn build firefox production

在您提交Pull Request之前，您需要确保yarn lint、yarn test和yarn build-all通过测试，否则可能会影响 github actions 自动构建。

yarn lint
# 一些lint错误会被自动修复
# yarn fix

yarn test

yarn build-all

注意: 同步功能的 API Key 和 Secret 不包含在此存储库中。 要开发同步功能，请在 .env 文件中设置您自己的 API Key 和 Secret。

DROPBOX_API_KEY=...
DROPBOX_API_SECRET=...
GOOGLE_DRIVE_API_KEY=...
GOOGLE_DRIVE_API_SECRET=...

语言

添加一个语言,

1. 定义一个 ISO 语言代码，例如en指的是 kLanguageInfoTable.
2. 复制 src/locales/en.json.ts 到 src/locales/${languageCode}.json.ts 并翻译条目.
3. 打开 src/scripts/dayjs-locales.ts 并导入 dayjs 语言环境.
4. 要本地化网上商店的描述和屏幕截图，请创建 web-store-assets/${languageCode}/ 并添加文件。
   • 屏幕截图本地化仅在 Chrome 网上应用店可用。
   • 屏幕截图应为 1280x800。

作者

iorate (Twitter)

许可证

uBlacklist 基于 MIT License 开源。