- 禁止在国内平台传播
- 本仓库仅供本人学习使用
- 精力有限，随缘更新
- CloudFlare源 (链接已对国内优选加速)
https://gkd.chenge.eu.org/gkd.json5- bgithub源 (国内可用,同步及时30min内,但可能随时挂掉！)
https://raw.bgithub.xyz/Lin-arm/GKD_subscription/main/dist/gkd.json5- jsdelivr源（滞后12h）:
https://fastly.jsdelivr.net/gh/cjy0812/Ling033_GKD_Rules@main/dist/gkd.json5- Github源:
https://github.com/cjy0812/Ling033_GKD_Rules/raw/refs/heads/main/dist/gkd.json5-
查看 规则编写教程 By @Snoopy1866
-
本人自用GKD审查工具Plus版 基于原版做出更激进的增强体验与功能修改
-
使用 GKD网页审查工具增强脚本 可以高度自定义从网页复制出来的规则，提高规则编写效率
-
使用 GKD订阅模板 快速构建自己的订阅
-
如何编写订阅/贡献此项目 -> 查看 贡献指南
请安装最新版 nodejs 和 pnpm 运行, 以及使用 vscode 打开项目
Important
选择器需要使用 nodejs@22 的 WasmGc 来校验 Java/Kotlin 正则表达式, 确保使用 nodejs>=22
- nodejs>=22 https://nodejs.org/en/download
- pnpm>=9 https://pnpm.io/zh/installation
- vscode https://code.visualstudio.com
安装好后使用模板, 假设您刚刚使用 Use this template 创建的仓库是 https://github.com/username/subscription
接下来下载并初始化环境
git clone https://github.com/username/subscription
cd subscription
pnpm install如果因为网络问题安装失败, 将上面的 pnpm install 换成下面命令使用 阿里镜像源 重新安装即可
pnpm install --registry=https://registry.npmmirror.com
至此环境已在 subscription 目录下初始化完毕, 使用 vscode 打开目录即可开始开发
接下来下面所有的示例链接都基于 username/subscription, 请自行替换后打开
pnpm install 用于安装依赖, 如果您的 ./package.json 发生变化, 则需要再次运行 pnpm install
如果您无法初始化 nodejs 环境, 那可以直接使用 github 网页编辑文件后在线提交, 点击下面链接即可在线编辑
https://github.com/username/subscription/edit/main/src/subscription.ts
- 订阅详情 ./src/subscription.ts
- 全局规则 ./src/globalGroups.ts
- 规则分类 ./src/categories.ts
- 应用规则 ./src/apps
在 vscode 内使用鼠标悬浮在任意字段上即可查看注释说明, 也可在 https://gkd.li/api 搜索查看
现在您可编辑 ./src 下的文件来自定义您的订阅, 构建后的订阅文件处于 ./dist 目录下
另外您必须修改 订阅详情 ./src/subscription.ts 下的 id 字段, 否则可能会和其它订阅冲突, 填一个较大的随机数字即可
我们使用 prettier 来格式化代码 和 eslint 来检测并修复代码错误
同时使用 simple-git-hooks 在您提交代码时运行格式化和代码检测修复脚本
当您的代码存在错误时, 它会阻止您提交代码并输出具体错误以供您手动修复后再次提交
当提交代码到仓库时, 我们也需要使用 github actions 来帮助自动格式化并修复代码, 因此您需要开启仓库的此项权限
打开 https://github.com/username/subscription/settings/actions
然后找到 Workflow permissions 点击 Read and write permissions 然后点击下方的 Save 即可
我们需要将 ./src 分散的文件合并为一个 gkd.json5 的最终订阅文件并输出到 ./dist 目录下
推荐使用 github actions 进行构建, 在 ./.github/workflows 下有 3 个工作流
我们使用其中的 build_release.yml 构建并发布
打开 https://github.com/username/subscription/actions/workflows/build_release.yml
然后点击右侧的 Run workflow 即可运行并发布
构建后订阅将输出到 dist 目录下, gkd.json 的文件订阅地址如下, 复制后到 GKD 添加即可
https://raw.githubusercontent.com/username/subscription/main/dist/gkd.json5raw.githubusercontent.com 在大陆的访问常常无法访问
您可以换成 https://fastly.jsdelivr.net/gh/username/subscription@main/dist/gkd.json5 加速访问
如果无法访问 raw.githubusercontent.com 和 fastly.jsdelivr.net, 可以使用 CloudFlare 托管加速访问
- 一个 CloudFlare 账号
- 一个 自定义域名(可选，如果没有用自带也可以，就是没有中国大陆优选加速)
请在仓库根目录下添加 wrangler.toml 文件, 内容如下示例，根据情况修改
name = "ling033-gkd-rules" # ← 必须和你在 Cloudflare 创建 Worker 时填的项目名称**完全一致**（小写+连字符）
compatibility_date = "2026-04-08"
[assets]
directory = "./dist" # 关键！指向你的 JSON5 文件所在目录
# not_found_handling = "404-page" # 可选，你的订阅文件通常不需要- 登录 CloudFlare 账号
Worker和Pages-创建应用程序
- 选择
Continue with GitHub
- 选择自己的账号
username在下面选择自己的subscription仓库, 点击下一步即可创建应用程序
- 修改项目名称务必和
wrangler.toml里name相同，删掉构建命令，注意项目名称小写只能使用-后点击部署。
- 禁用
自带域名没有自定义域名的不要禁用(你需要ta!!!)
- 为了防止一提交就构建我们需要现在检测变动构建路径为产物构建我们需要限制构建产物的路径
- 到这里没有自定义域名, 就可以使用CF自带域名了，下面不用看了直接看结尾。
有自己域名的可以进行下一步了
设置-+添加-路由-区域选择自己的域名-路由填写一个自己喜欢的子域名，自己的根域也不是不行，你开心就好~然后给点击添加路由
至此你可以在你的域名后面加上/gkd.json5即可访问
注意: 大多数情况下, 你不需要自定义, 使用默认配置时, 下面此节教程无需了解
你可以在 ./package.json 下添加 gkd 属性配置自定义构建选项
{
"gkd": {
"outDir": "dist",
"file": "gkd.json5",
"versionFile": "gkd.version.json5",
"changelog": "CHANGELOG.md",
"README.md": "README.md"
}
}这个 gkd 属性的类型如下
/**
* @default package.json.gkd
*/
type GkdConfig = {
/**
* @default 'dist'
*/
outDir?: string;
/**
* @default 'gkd.json5'
*/
file?: string;
/**
* @default 'gkd.version.json5'
*/
versionFile?: string;
/**
* @default 'CHANGELOG.md'
*/
changelog?: string;
/**
* @default 'README.md'
*/
readme?: string;
};如果不想写配置文件, 也可以将这个参数直接传递给 @gkd-kit/tools 的 updateDist 函数
手动传递参数的时候, 你必须显式将路径(非文件名)参数传递给 ./.github/workflows/build_release.yml 下的 updatePkgVersion 和 stdoutGkdVersion 函数