{"_id":"@dashuaibi45678/gkd-subscription","_rev":"4-a1a0599fb51a6ee955f1f3cb24c71562","name":"@dashuaibi45678/gkd-subscription","dist-tags":{"latest":"1.0.5"},"versions":{"1.0.2":{"name":"@dashuaibi45678/gkd-subscription","version":"1.0.2","author":{"name":"大帅比45678"},"_id":"@dashuaibi45678/gkd-subscription@1.0.2","maintainers":[{"name":"dashuaibi45678","email":"dashuaibi45678@vip.qq.com"}],"gkd":{"file":"gkd.json5","outDir":"dist","README.md":"README.md","changelog":"CHANGELOG.md","versionFile":"gkd.version.json5"},"dist":{"shasum":"00d1b622fe536463731cc05d8cfff85aef61581b","tarball":"https://registry.npmjs.org/@dashuaibi45678/gkd-subscription/-/gkd-subscription-1.0.2.tgz","fileCount":6,"integrity":"sha512-T8GauSRvTcn6HRW0hQ4aoJi1WSjP02Due3ULshy0uQ9wy36HMs4A/ZURr0Yf7BYkZ+AWWFucAfJtjVir1eAJDA==","signatures":[{"sig":"MEUCIQC7W+HDyuZ/bbvNnhZC8+68Z8RhEpH9Jsbm5XJkIjXxqwIgehQxydgVmKhnqi0pKISBLVoPSSL+PhuI8m6aSNT8coY=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":14085},"type":"module","_from":"file:dashuaibi45678-gkd-subscription-1.0.2.tgz","volta":{"node":"20.12.1"},"engines":{"node":">=20"},"scripts":{"lint":"eslint --cache --fix ./**/*.{js,cjs,mjs,ts,jsx,tsx}","build":"tsc --noEmit && tsx ./scripts/build.ts","check":"tsc --noEmit && tsx ./scripts/check.ts","format":"prettier --cache --write ./**/*.{js,cjs,mjs,ts,jsx,tsx,json}","postinstall":"simple-git-hooks"},"_npmUser":{"name":"dashuaibi45678","email":"dashuaibi45678@vip.qq.com"},"_resolved":"/tmp/b9d4c2ec1ff4f39ed5e4d98136cc5008/dashuaibi45678-gkd-subscription-1.0.2.tgz","_integrity":"sha512-T8GauSRvTcn6HRW0hQ4aoJi1WSjP02Due3ULshy0uQ9wy36HMs4A/ZURr0Yf7BYkZ+AWWFucAfJtjVir1eAJDA==","_npmVersion":"10.5.2","description":"GKD 订阅模板, 此仓库方便您直接构建自己订阅, 点击右上角 [Use this template](https://github.com/new?template_name=subscription-template&template_owner=gkd-kit) 即可使用","directories":{},"lint-staged":{"*.json":["prettier --cache --write"],"*.{js,cjs,mjs,ts,jsx,tsx}":["prettier --cache --write","eslint --cache --fix"]},"_nodeVersion":"20.13.1","dependencies":{"tsx":"4.10.5","json5":"2.2.3","eslint":"8.57.0","prettier":"3.2.5","typescript":"5.4.5","@types/node":"20.12.12","lint-staged":"15.2.2","@gkd-kit/api":"0.0.5","@gkd-kit/tools":"0.2.0","@commitlint/cli":"19.3.0","@gkd-kit/define":"0.0.1","simple-git-hooks":"2.11.1","@commitlint/types":"19.0.3","eslint-define-config":"2.1.0","eslint-config-prettier":"9.1.0","@typescript-eslint/parser":"7.10.0","eslint-plugin-unused-imports":"3.2.0","@commitlint/config-conventional":"19.2.2","@typescript-eslint/eslint-plugin":"7.10.0"},"engineStrict":true,"publishConfig":{"access":"public","registry":"https://registry.npmjs.org/"},"_hasShrinkwrap":false,"simple-git-hooks":{"pre-push":"pnpm run check","commit-msg":"pnpm exec commitlint --config commitlint.config.ts --edit ${1}","pre-commit":"pnpm exec lint-staged"},"_npmOperationalInternal":{"tmp":"tmp/gkd-subscription_1.0.2_1716968196359_0.0535497967953511","host":"s3://npm-registry-packages"}},"1.0.3":{"name":"@dashuaibi45678/gkd-subscription","version":"1.0.3","author":{"name":"大帅比45678"},"_id":"@dashuaibi45678/gkd-subscription@1.0.3","maintainers":[{"name":"dashuaibi45678","email":"dashuaibi45678@vip.qq.com"}],"gkd":{"file":"gkd.json5","outDir":"dist","README.md":"README.md","changelog":"CHANGELOG.md","versionFile":"gkd.version.json5"},"dist":{"shasum":"058fd356077d5c613bd9dd572cbe58edd2b06e66","tarball":"https://registry.npmjs.org/@dashuaibi45678/gkd-subscription/-/gkd-subscription-1.0.3.tgz","fileCount":6,"integrity":"sha512-QEMQLwf5AWpbY+BCT5SgZir1Zi5eMtNCdYDmvQGJHVUFuO8nau0oeK+pPgvYiyHVoB6e2LY72qW9z6XME0/iLg==","signatures":[{"sig":"MEYCIQCImXIaOBnNjtYZufqFJNqUBzbAoF1+XP4hmX//dvrS+wIhANcVgXfUZzKTlEnf5y+7nPfRba9wKXWp7B1m1u8BduEu","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":15854},"type":"module","_from":"file:dashuaibi45678-gkd-subscription-1.0.3.tgz","volta":{"node":"20.12.1"},"engines":{"node":">=20"},"scripts":{"lint":"eslint --cache --fix ./**/*.{js,cjs,mjs,ts,jsx,tsx}","build":"tsc --noEmit && tsx ./scripts/build.ts","check":"tsc --noEmit && tsx ./scripts/check.ts","format":"prettier --cache --write ./**/*.{js,cjs,mjs,ts,jsx,tsx,json}","postinstall":"simple-git-hooks"},"_npmUser":{"name":"dashuaibi45678","email":"dashuaibi45678@vip.qq.com"},"_resolved":"/tmp/04c8169c7056148b156aff644d7892c0/dashuaibi45678-gkd-subscription-1.0.3.tgz","_integrity":"sha512-QEMQLwf5AWpbY+BCT5SgZir1Zi5eMtNCdYDmvQGJHVUFuO8nau0oeK+pPgvYiyHVoB6e2LY72qW9z6XME0/iLg==","_npmVersion":"10.5.2","description":"GKD 订阅模板, 此仓库方便您直接构建自己订阅, 点击右上角 [Use this template](https://github.com/new?template_name=subscription-template&template_owner=gkd-kit) 即可使用","directories":{},"lint-staged":{"*.json":["prettier --cache --write"],"*.{js,cjs,mjs,ts,jsx,tsx}":["prettier --cache --write","eslint --cache --fix"]},"_nodeVersion":"20.13.1","dependencies":{"tsx":"4.10.5","json5":"2.2.3","eslint":"8.57.0","prettier":"3.2.5","typescript":"5.4.5","@types/node":"20.12.12","lint-staged":"15.2.2","@gkd-kit/api":"0.0.5","@gkd-kit/tools":"0.2.0","@commitlint/cli":"19.3.0","@gkd-kit/define":"0.0.1","simple-git-hooks":"2.11.1","@commitlint/types":"19.0.3","eslint-define-config":"2.1.0","eslint-config-prettier":"9.1.0","@typescript-eslint/parser":"7.10.0","eslint-plugin-unused-imports":"3.2.0","@commitlint/config-conventional":"19.2.2","@typescript-eslint/eslint-plugin":"7.10.0"},"engineStrict":true,"publishConfig":{"access":"public","registry":"https://registry.npmjs.org/"},"_hasShrinkwrap":false,"simple-git-hooks":{"pre-push":"pnpm run check","commit-msg":"pnpm exec commitlint --config commitlint.config.ts --edit ${1}","pre-commit":"pnpm exec lint-staged"},"_npmOperationalInternal":{"tmp":"tmp/gkd-subscription_1.0.3_1717084146573_0.654889812856962","host":"s3://npm-registry-packages"}},"1.0.4":{"name":"@dashuaibi45678/gkd-subscription","version":"1.0.4","author":{"name":"大帅比45678"},"_id":"@dashuaibi45678/gkd-subscription@1.0.4","maintainers":[{"name":"dashuaibi45678","email":"dashuaibi45678@vip.qq.com"}],"gkd":{"file":"gkd.json5","outDir":"dist","README.md":"README.md","changelog":"CHANGELOG.md","versionFile":"gkd.version.json5"},"dist":{"shasum":"c4830d8fe2fe6f4e68923ff6422d48103f3dd89a","tarball":"https://registry.npmjs.org/@dashuaibi45678/gkd-subscription/-/gkd-subscription-1.0.4.tgz","fileCount":6,"integrity":"sha512-/BZu75fbuor5J6Im+9RTmSDZdk6KnXoQD3kjbs3y2Js2TJJfEVHS+PTwTWsceunOHADyDIcg1fnsbUMsMsRuNQ==","signatures":[{"sig":"MEQCIAr2yTabu2VYT5fh8oRAzUXiJtGH6odBOnj10aU7xdpEAiBOncKMCg5CFgWLsPPLhlwyqAB6bxrvv0oAEzmBuqRmug==","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":19492},"type":"module","_from":"file:dashuaibi45678-gkd-subscription-1.0.4.tgz","volta":{"node":"20.12.1"},"engines":{"node":">=20"},"scripts":{"lint":"eslint --cache --fix ./**/*.{js,cjs,mjs,ts,jsx,tsx}","build":"tsc --noEmit && tsx ./scripts/build.ts","check":"tsc --noEmit && tsx ./scripts/check.ts","format":"prettier --cache --write ./**/*.{js,cjs,mjs,ts,jsx,tsx,json}","postinstall":"simple-git-hooks"},"_npmUser":{"name":"dashuaibi45678","email":"dashuaibi45678@vip.qq.com"},"_resolved":"/tmp/3d754651df4a88120a601095c327b917/dashuaibi45678-gkd-subscription-1.0.4.tgz","_integrity":"sha512-/BZu75fbuor5J6Im+9RTmSDZdk6KnXoQD3kjbs3y2Js2TJJfEVHS+PTwTWsceunOHADyDIcg1fnsbUMsMsRuNQ==","_npmVersion":"10.5.2","description":"GKD 订阅模板, 此仓库方便您直接构建自己订阅, 点击右上角 [Use this template](https://github.com/new?template_name=subscription-template&template_owner=gkd-kit) 即可使用","directories":{},"lint-staged":{"*.json":["prettier --cache --write"],"*.{js,cjs,mjs,ts,jsx,tsx}":["prettier --cache --write","eslint --cache --fix"]},"_nodeVersion":"20.13.1","dependencies":{"tsx":"4.10.5","json5":"2.2.3","eslint":"8.57.0","prettier":"3.2.5","typescript":"5.4.5","@types/node":"20.12.12","lint-staged":"15.2.2","@gkd-kit/api":"0.0.5","@gkd-kit/tools":"0.2.0","@commitlint/cli":"19.3.0","@gkd-kit/define":"0.0.1","simple-git-hooks":"2.11.1","@commitlint/types":"19.0.3","eslint-define-config":"2.1.0","eslint-config-prettier":"9.1.0","@typescript-eslint/parser":"7.10.0","eslint-plugin-unused-imports":"3.2.0","@commitlint/config-conventional":"19.2.2","@typescript-eslint/eslint-plugin":"7.10.0"},"engineStrict":true,"publishConfig":{"access":"public","registry":"https://registry.npmjs.org/"},"_hasShrinkwrap":false,"simple-git-hooks":{"pre-push":"pnpm run check","commit-msg":"pnpm exec commitlint --config commitlint.config.ts --edit ${1}","pre-commit":"pnpm exec lint-staged"},"_npmOperationalInternal":{"tmp":"tmp/gkd-subscription_1.0.4_1717224693467_0.3867453295374794","host":"s3://npm-registry-packages"}},"1.0.5":{"name":"@dashuaibi45678/gkd-subscription","version":"1.0.5","type":"module","author":{"name":"大帅比45678"},"gkd":{"outDir":"dist","file":"gkd.json5","versionFile":"gkd.version.json5","changelog":"CHANGELOG.md","README.md":"README.md"},"simple-git-hooks":{"pre-commit":"pnpm exec lint-staged","commit-msg":"pnpm exec commitlint --config commitlint.config.ts --edit ${1}","pre-push":"pnpm run check"},"lint-staged":{"*.{js,cjs,mjs,ts,jsx,tsx}":["prettier --cache --write","eslint --cache --fix"],"*.json":["prettier --cache --write"]},"publishConfig":{"access":"public","registry":"https://registry.npmjs.org/"},"dependencies":{"@commitlint/cli":"19.3.0","@commitlint/config-conventional":"19.2.2","@commitlint/types":"19.0.3","@gkd-kit/api":"0.0.5","@gkd-kit/define":"0.0.1","@gkd-kit/tools":"0.2.0","@types/node":"20.12.12","@typescript-eslint/eslint-plugin":"7.10.0","@typescript-eslint/parser":"7.10.0","eslint":"8.57.0","eslint-config-prettier":"9.1.0","eslint-define-config":"2.1.0","eslint-plugin-unused-imports":"3.2.0","json5":"2.2.3","lint-staged":"15.2.2","prettier":"3.2.5","simple-git-hooks":"2.11.1","tsx":"4.10.5","typescript":"5.4.5"},"volta":{"node":"20.12.1"},"engineStrict":true,"engines":{"node":">=20"},"scripts":{"postinstall":"simple-git-hooks","format":"prettier --cache --write ./**/*.{js,cjs,mjs,ts,jsx,tsx,json}","lint":"eslint --cache --fix ./**/*.{js,cjs,mjs,ts,jsx,tsx}","check":"tsc --noEmit && tsx ./scripts/check.ts","build":"tsc --noEmit && tsx ./scripts/build.ts"},"_id":"@dashuaibi45678/gkd-subscription@1.0.5","description":"GKD 订阅模板, 此仓库方便您直接构建自己订阅, 点击右上角 [Use this template](https://github.com/new?template_name=subscription-template&template_owner=gkd-kit) 即可使用","_integrity":"sha512-OGjCzpIR0SuiF2nWqC/jA6iTHPEFnA9R2CJ0CK8m3dtnM35y1hDksj2zl88mvde9kDDbaWIO5aHMUx9vcmQNfg==","_resolved":"/tmp/7cd9407c6c97cf9dcd28d5d6a8bc479d/dashuaibi45678-gkd-subscription-1.0.5.tgz","_from":"file:dashuaibi45678-gkd-subscription-1.0.5.tgz","_nodeVersion":"20.19.0","_npmVersion":"10.8.2","dist":{"integrity":"sha512-OGjCzpIR0SuiF2nWqC/jA6iTHPEFnA9R2CJ0CK8m3dtnM35y1hDksj2zl88mvde9kDDbaWIO5aHMUx9vcmQNfg==","shasum":"845acf0cff984869fea248d7f5a5180499122323","tarball":"https://registry.npmjs.org/@dashuaibi45678/gkd-subscription/-/gkd-subscription-1.0.5.tgz","fileCount":6,"unpackedSize":19494,"signatures":[{"keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U","sig":"MEQCIHLHK293ZN0Bt2gKIkv7QjwJUEH1t7retyGEY7+iI0tyAiBW163tk71VQLO4o/t0CYVI7rGydF8b+4ut1HjvUq1gbQ=="}]},"_npmUser":{"name":"dashuaibi45678","email":"dashuaibi45678@vip.qq.com"},"directories":{},"maintainers":[{"name":"dashuaibi45678","email":"dashuaibi45678@vip.qq.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages-npm-production","tmp":"tmp/gkd-subscription_1.0.5_1743878171208_0.1302757046483336"},"_hasShrinkwrap":false}},"time":{"created":"2024-05-29T07:36:36.223Z","modified":"2025-04-05T18:36:11.644Z","1.0.2":"2024-05-29T07:36:36.501Z","1.0.3":"2024-05-30T15:49:06.753Z","1.0.4":"2024-06-01T06:51:33.635Z","1.0.5":"2025-04-05T18:36:11.439Z"},"author":{"name":"大帅比45678"},"description":"GKD 订阅模板, 此仓库方便您直接构建自己订阅, 点击右上角 [Use this template](https://github.com/new?template_name=subscription-template&template_owner=gkd-kit) 即可使用","maintainers":[{"name":"dashuaibi45678","email":"dashuaibi45678@vip.qq.com"}],"readme":"# subscription-template\n\nGKD 订阅模板, 此仓库方便您直接构建自己订阅, 点击右上角 [Use this template](https://github.com/new?template_name=subscription-template&template_owner=gkd-kit) 即可使用\n\n## 配置环境\n\n请安装最新版 nodejs 和 pnpm 运行, 以及使用 vscode 打开项目\n\n- node>=20 <https://nodejs.org/en/download>\n- pnpm>=9 <https://pnpm.io/zh/installation>\n- vscode <https://code.visualstudio.com>\n\n安装好后使用模板, 假设您刚刚使用 `Use this template` 创建的仓库是 `https://github.com/username/subscription`\n\n接下来下载并初始化环境\n\n```shell\ngit clone https://github.com/username/subscription\ncd subscription\npnpm install\n```\n\n![image](https://github.com/gkd-kit/gkd/assets/38517192/64f9da9d-8c6b-4a57-8fe8-ef13ef91346a)\n\n至此环境已在 `subscription` 目录下初始化完毕, 使用 vscode 打开目录即可开始开发\n\n接下来下面所有的示例链接都基于 `username/subscription`, 请自行替换后打开\n\n`pnpm install` 用于安装依赖, 如果您的 [./package.json](./package.json) 发生变化, 则需要再次运行 `pnpm install`\n\n---\n\n如果您无法初始化 nodejs 环境, 那可以直接使用 github 网页编辑文件后在线提交, 点击下面链接即可在线编辑\n\n<https://github.com/username/subscription/edit/main/src/subscription.ts>\n\n![image](https://github.com/gkd-kit/gkd/assets/38517192/6a724cd9-b2cd-429d-bf2e-87f2c8b3d566)\n\n## 目录结构\n\n- 订阅详情 [./src/subscription.ts](./src/subscription.ts)\n- 全局规则 [./src/globalGroups.ts](./src/globalGroups.ts)\n- 规则分类 [./src/categories.ts](./src/categories.ts)\n- 应用规则 [./src/apps](./src/apps/)\n\n在 vscode 内使用鼠标悬浮在任意字段上即可查看注释说明, 也可在 <https://gkd.li/api> 搜索查看\n\n![image](https://github.com/gkd-kit/gkd/assets/38517192/35400b43-0d79-4a67-bd4c-6915613488db)\n\n现在您可编辑 [./src](./src/) 下的文件来自定义您的订阅, 构建后的订阅文件处于 [./dist](./dist/) 目录下\n\n另外您必须修改 订阅详情 [./src/subscription.ts](./src/subscription.ts) 下的 id 字段, 否则可能会和其它订阅冲突, 填一个较大的随机数字即可\n\n## 提交规范\n\n我们使用 [commitlint](https://github.com/conventional-changelog/commitlint) 来校验提交信息\n\n它要求提交的标题需要符合规范, 不符合规范的无法提交, 您可以查看它的文档规范你的提交\n\n## 格式修复\n\n我们使用 [prettier](https://github.com/prettier/prettier) 来格式化代码 和 [eslint](https://github.com/eslint/eslint) 来检测并修复代码错误\n\n同时使用 [simple-git-hooks](https://github.com/toplenboren/simple-git-hooks) 在您提交代码时运行格式化和代码检测修复脚本\n\n当您的代码存在错误时, 它会阻止您提交代码并输出具体错误以供您手动修复后再次提交\n\n当提交代码到仓库时, 我们也需要使用 github actions 来帮助自动格式化并修复代码, 因此您需要开启仓库的此项权限\n\n打开 <https://github.com/username/subscription/settings/actions>\n\n然后找到 Workflow permissions 点击 Read and write permissions 然后点击下方的 Save 即可\n\n![image](https://github.com/gkd-kit/gkd/assets/38517192/e3bbefe3-7745-42c7-adc8-3cfe2757c9cf)\n\n## 构建订阅\n\n我们需要将 [./src](./src/) 分散的文件合并为一个 gkd.json5 的最终订阅文件并输出到 [./dist](./dist/) 目录下\n\n推荐使用 github actions 进行构建, 在 [./.github/workflows](./.github/workflows) 下有 3 个工作流\n\n我们使用其中的 `build_release.yml` 构建并发布\n\n打开 <https://github.com/username/subscription/actions/workflows/build_release.yml>\n\n然后点击右侧的 `Run workflow` 即可运行并发布\n\n![image](https://github.com/gkd-kit/gkd/assets/38517192/bbaf5113-8ab3-4be0-9a79-ee7a7389a58c)\n\n构建后订阅将输出到 dist 目录下, gkd.json 的文件订阅地址如下, 复制后到 GKD 添加即可\n\n```txt\nhttps://raw.githubusercontent.com/username/subscription/main/dist/gkd.json5\n```\n\n## 镜像加速\n\nraw.githubusercontent.com 在大陆的访问常常无法访问\n\n您可以换成 <https://fastly.jsdelivr.net/gh/username/subscription@main/dist/gkd.json5> 加速访问\n\n如果无法访问 raw.githubusercontent.com 和 fastly.jsdelivr.net\n\n您可以将本仓库发布到 npm 上, 然后通过 registry.npmmirror.com 加速访问\n\n要发布到 npm 上, 必须先将 [./package.json](./package.json) 的 name 字段改成未使用的包名, 否则发布失败\n\n您可以改成 `gkd-subscription-xxxx` 其中 `xxxx` 是订阅的 id 或者随机字母数字, 总之不冲突就行\n\n或者改成 `@your_npm_name/subscription`, 这种类型是 scope 名称, 其中 `your_npm_name` 是你下面要注册的 npm 用户名\n\n![image](https://github.com/gkd-kit/gkd/assets/38517192/79817967-6f97-4935-9bf3-179bbf50b3aa)\n\n接下来获取 token, 你需要先注册 <https://www.npmjs.com>, 然后到 Access Tokens 界面点击 Generate New Token 选择 Classic Token 后随便输入 Name 选择 Publish 即可生成并复制\n\n![image](https://github.com/gkd-kit/gkd/assets/38517192/ca5eaf26-3705-4dc7-9584-4a235bbefde2)\n\n![image](https://github.com/gkd-kit/gkd/assets/38517192/6da188ab-e415-44de-b2f7-3f985ab4d401)\n\n![image](https://github.com/gkd-kit/gkd/assets/38517192/55db57f6-1021-4d85-afd0-fe7df1f9bbcf)\n\n复制后打开 <https://github.com/username/subscription/settings/secrets/actions/new>\n\n在 Name 输入 `NPM_TOKEN`, 在 Secret 输入刚刚复制的 token, 点击 Add secret 即可添加成功\n\n![image](https://github.com/gkd-kit/gkd/assets/38517192/72b062d8-4540-4602-82fe-416ea5348014)\n\n然后只需要重复上面的 构建订阅 步骤即可发布, 发布后得到的镜像加速链接如下\n\n```txt\nhttps://registry.npmmirror.com/gkd-subscription-xxxx/latest/files/dist/gkd.json5\n```\n\n注: 将 gkd-subscription-xxxx 换成您的包名\n\n如果你的包名是 `@your_npm_name/subscription` 这种类型, 加速链接是\n\n```txt\nhttps://registry.npmmirror.com/@your_npm_name/subscription/latest/files/dist/gkd.json5\n```\n\n由于 npmmirror 被恶意刷流量后已经改为白名单模式, 不在白名单内的包, 上面的链接无法正常加速访问\n\n因此要使上面的链接被正常访问, 你需要向 <https://github.com/cnpm/unpkg-white-list> 提交 pr 将你的包添加到白名单\n\n## 自定义配置文件\n\n注意: **大多数情况下, 你不需要自定义, 使用默认配置时, 下面此节教程无需了解**\n\n你可以在 [./package.json](./package.json) 下添加 gkd 属性配置自定义构建选项\n\n```json\n{\n  \"gkd\": {\n    \"outDir\": \"dist\",\n    \"file\": \"gkd.json5\",\n    \"versionFile\": \"gkd.version.json5\",\n    \"changelog\": \"CHANGELOG.md\",\n    \"README.md\": \"README.md\"\n  }\n}\n```\n\n这个 gkd 属性的类型如下\n\n```ts\n/**\n * @default package.json.gkd\n */\ntype GkdConfig = {\n    /**\n     * @default 'dist'\n     */\n    outDir?: string;\n    /**\n     * @default 'gkd.json5'\n     */\n    file?: string;\n    /**\n     * @default 'gkd.version.json5'\n     */\n    versionFile?: string;\n    /**\n     * @default 'CHANGELOG.md'\n     */\n    changelog?: string;\n    /**\n     * @default 'README.md'\n     */\n    readme?: string;\n};\n```\n\n如果不想写配置文件, 也可以将这个参数直接传递给 `@gkd-kit/tools` 的 `updateDist` 函数\n\n手动传递参数的时候, 你必须显式将路径(非文件名)参数传递给 [./.github/workflows/build_release.yml](./.github/workflows/build_release.yml) 下的 `updatePkgVersion` 和 `stdoutGkdVersion` 函数\n","readmeFilename":"README.md"}