From 9cf3fccacd0fd4fe96bd7fa549ce0506183a5621 Mon Sep 17 00:00:00 2001 From: sansan <77180927+sansan0@users.noreply.github.com> Date: Tue, 18 Nov 2025 11:22:55 +0800 Subject: [PATCH] =?UTF-8?q?docs:=20=E5=A2=9E=E5=8A=A0=E6=9B=B4=E8=AF=A6?= =?UTF-8?q?=E7=BB=86=E7=9A=84=E6=96=B0=E6=89=8B=E9=85=8D=E7=BD=AE=E8=AF=B4?= =?UTF-8?q?=E6=98=8E=EF=BC=8C=E8=AF=B7=E5=8F=82=E7=85=A7=E3=80=90=E5=BF=AB?= =?UTF-8?q?=E9=80=9F=E5=BC=80=E5=A7=8B=E3=80=91=E9=83=A8=E5=88=86=E8=BF=9B?= =?UTF-8?q?=E8=A1=8C=E9=A1=B9=E7=9B=AE=E9=83=A8=E7=BD=B2?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README-EN.md | 88 ++++++++++++++++++++++++++++++++++++---------------- readme.md | 88 ++++++++++++++++++++++++++++++++++++---------------- 2 files changed, 122 insertions(+), 54 deletions(-) diff --git a/README-EN.md b/README-EN.md index 91d0888..e31e3bf 100644 --- a/README-EN.md +++ b/README-EN.md @@ -8,7 +8,7 @@ sansan0%2FTrendRadar | Trendshift -302.AI logo +302.AI logo [![GitHub Stars](https://img.shields.io/github/stars/sansan0/TrendRadar?style=flat-square&logo=github&color=yellow)](https://github.com/sansan0/TrendRadar/stargazers) [![GitHub Forks](https://img.shields.io/github/forks/sansan0/TrendRadar?style=flat-square&logo=github&color=blue)](https://github.com/sansan0/TrendRadar/network/members) @@ -812,22 +812,33 @@ frequency_words.txt file added **required word** feature, using + sign 2. **Setup GitHub Secrets (Choose your needed platforms)**: - In your forked repo, go to `Settings` > `Secrets and variables` > `Actions` > `New repository secret`, then configure one or more notification platforms as needed: + In your forked repo, go to `Settings` > `Secrets and variables` > `Actions` > `New repository secret` - You can configure multiple platforms simultaneously, system will send notifications to all configured platforms. + **📌 Important Instructions (Please Read Carefully):** - Effect similar to the image below, one name corresponds to one secret. After saving, you won't see the secret value when re-editing, which is normal. + - ✅ **One Name for One Secret**: For each configuration item, click the "New repository secret" button once and fill in a pair of "Name" and "Secret" + - ✅ **Cannot See Value After Saving is Normal**: For security reasons, after saving, you can only see the Name when re-editing, but not the Secret value + - ⚠️ **DO NOT Create Custom Names**: The Secret Name must **strictly use** the names listed below (e.g., `WEWORK_WEBHOOK_URL`, `FEISHU_WEBHOOK_URL`, etc.). Do not modify or create new names arbitrarily, or the system will not recognize them + - 💡 **Can Configure Multiple Platforms**: The system will send notifications to all configured platforms - GitHub Secrets + **Configuration Example:** + + GitHub Secrets Configuration Example + + As shown above, each row is a configuration item: + - **Name**: Must use the fixed names listed in the expanded sections below (e.g., `WEWORK_WEBHOOK_URL`) + - **Secret (Value)**: Fill in the actual content obtained from the corresponding platform (e.g., Webhook URL, Token, etc.) + +
👉 Click to expand: WeWork Bot (Simplest and fastest configuration)
- **GitHub Secret Configuration:** - - Name: `WEWORK_WEBHOOK_URL` - - Value: Your WeWork bot Webhook address + **GitHub Secret Configuration (⚠️ Name must match exactly):** + - **Name**: `WEWORK_WEBHOOK_URL` (Please copy and paste this name, do not type manually to avoid typos) + - **Secret (Value)**: Your WeWork bot Webhook address
@@ -846,9 +857,9 @@ frequency_words.txt file added **required word** feature, using + sign 👉 Click to expand: Feishu Bot (Most user-friendly message display)
- **GitHub Secret Configuration:** - - Name: `FEISHU_WEBHOOK_URL` - - Value: Your Feishu bot Webhook address (link starts with https://www.feishu.cn/flow/api/trigger-webhook/********) + **GitHub Secret Configuration (⚠️ Name must match exactly):** + - **Name**: `FEISHU_WEBHOOK_URL` (Please copy and paste this name, do not type manually) + - **Secret (Value)**: Your Feishu bot Webhook address (link starts with https://www.feishu.cn/flow/api/trigger-webhook/********)
Two methods available, **Method 1** is simpler, **Method 2** is more complex (but stable push) @@ -901,9 +912,9 @@ frequency_words.txt file added **required word** feature, using + sign 👉 Click to expand: DingTalk Bot
- **GitHub Secret Configuration:** - - Name: `DINGTALK_WEBHOOK_URL` - - Value: Your DingTalk bot Webhook address + **GitHub Secret Configuration (⚠️ Name must match exactly):** + - **Name**: `DINGTALK_WEBHOOK_URL` (Please copy and paste this name, do not type manually) + - **Secret (Value)**: Your DingTalk bot Webhook address
@@ -931,9 +942,14 @@ frequency_words.txt file added **required word** feature, using + sign 👉 Click to expand: Telegram Bot
- **GitHub Secret Configuration:** - - Name: `TELEGRAM_BOT_TOKEN` - Your Telegram Bot Token - - Name: `TELEGRAM_CHAT_ID` - Your Telegram Chat ID + **GitHub Secret Configuration (⚠️ Name must match exactly):** + - **Name**: `TELEGRAM_BOT_TOKEN` (Please copy and paste this name, do not type manually) + - **Secret (Value)**: Your Telegram Bot Token + + - **Name**: `TELEGRAM_CHAT_ID` (Please copy and paste this name, do not type manually) + - **Secret (Value)**: Your Telegram Chat ID + + **Note**: Telegram requires **two** Secrets, please click "New repository secret" button twice to add them separately
@@ -970,12 +986,23 @@ frequency_words.txt file added **required word** feature, using + sign
- **GitHub Secret Configuration:** - - Name: `EMAIL_FROM` - Sender email address - - Name: `EMAIL_PASSWORD` - Email password or authorization code - - Name: `EMAIL_TO` - Recipient email address (multiple separated by comma) or can be same as EMAIL_FROM, send to yourself - - Name: `EMAIL_SMTP_SERVER` - SMTP server address (optional, auto-detect if empty) - - Name: `EMAIL_SMTP_PORT` - SMTP port (optional, auto-detect if empty) + **GitHub Secret Configuration (⚠️ Name must match exactly):** + - **Name**: `EMAIL_FROM` (Please copy and paste this name, do not type manually) + - **Secret (Value)**: Sender email address + + - **Name**: `EMAIL_PASSWORD` (Please copy and paste this name, do not type manually) + - **Secret (Value)**: Email password or authorization code + + - **Name**: `EMAIL_TO` (Please copy and paste this name, do not type manually) + - **Secret (Value)**: Recipient email address (multiple separated by comma, or can be same as EMAIL_FROM to send to yourself) + + - **Name**: `EMAIL_SMTP_SERVER` (Optional, please copy and paste this name) + - **Secret (Value)**: SMTP server address (leave empty for auto-detection) + + - **Name**: `EMAIL_SMTP_PORT` (Optional, please copy and paste this name) + - **Secret (Value)**: SMTP port (leave empty for auto-detection) + + **Note**: Email push requires at least **3 required** Secrets (EMAIL_FROM, EMAIL_PASSWORD, EMAIL_TO), the last two are optional
@@ -1057,10 +1084,17 @@ frequency_words.txt file added **required word** feature, using + sign ❌ Bad example: news, alerts (too easy to guess) ``` - 3. **Configure GitHub Secret**: - - `NTFY_TOPIC`: Fill in your subscribed topic name - - `NTFY_SERVER_URL`: Leave empty (default uses ntfy.sh) - - `NTFY_TOKEN`: Leave empty + 3. **Configure GitHub Secret (⚠️ Name must match exactly)**: + - **Name**: `NTFY_TOPIC` (Please copy and paste this name, do not type manually) + - **Secret (Value)**: Fill in your subscribed topic name + + - **Name**: `NTFY_SERVER_URL` (Optional, please copy and paste this name) + - **Secret (Value)**: Leave empty (default uses ntfy.sh) + + - **Name**: `NTFY_TOKEN` (Optional, please copy and paste this name) + - **Secret (Value)**: Leave empty + + **Note**: ntfy requires at least 1 required Secret (NTFY_TOPIC), the last two are optional 4. **Test**: ```bash diff --git a/readme.md b/readme.md index ec9a4ca..46ee792 100644 --- a/readme.md +++ b/readme.md @@ -8,7 +8,7 @@ sansan0%2FTrendRadar | Trendshift -302.AI logo +302.AI logo [![GitHub Stars](https://img.shields.io/github/stars/sansan0/TrendRadar?style=flat-square&logo=github&color=yellow)](https://github.com/sansan0/TrendRadar/stargazers) [![GitHub Forks](https://img.shields.io/github/forks/sansan0/TrendRadar?style=flat-square&logo=github&color=blue)](https://github.com/sansan0/TrendRadar/network/members) @@ -847,22 +847,33 @@ frequency_words.txt 文件增加了一个【必须词】功能，使用 + 号 2. **设置 GitHub Secrets（选择你需要的平台）**: - 在你 Fork 后的仓库中，进入 `Settings` > `Secrets and variables` > `Actions` > `New repository secret`，然后根据需要配置以下任一或多个通知平台： + 在你 Fork 后的仓库中，进入 `Settings` > `Secrets and variables` > `Actions` > `New repository secret` - 可以同时配置多个平台，系统会向所有配置的平台发送通知。 + **📌 重要说明（请务必仔细阅读）：** - 效果类似下图，一个 name 对应一个 secret，保存完就行，你重新编辑看不到 secret 是正常情况。 + - ✅ **一个 Name 对应一个 Secret**：每添加一个配置项，点击一次"New repository secret"按钮，填写一对"Name"和"Secret" + - ✅ **保存后看不到值是正常的**：出于安全考虑，保存后重新编辑时，只能看到 Name（名称），看不到 Secret（值）的内容 + - ⚠️ **严禁自创名称**：Secret 的 Name（名称）必须**严格使用**下方列出的名称（如 `WEWORK_WEBHOOK_URL`、`FEISHU_WEBHOOK_URL` 等），不能自己随意修改或创造新名称，否则系统无法识别 + - 💡 **可以同时配置多个平台**：系统会向所有配置的平台发送通知 - GitHub Secrets + **配置示例：** + + GitHub Secrets 配置示例 + + 如上图所示，每一行是一个配置项： + - **Name（名称）**：必须使用下方展开内容中列出的固定名称（如 `WEWORK_WEBHOOK_URL`） + - **Secret（值）**：填写你从对应平台获取的实际内容（如 Webhook 地址、Token 等） + +
👉 点击展开：企业微信机器人（配置最简单最迅速）
- **GitHub Secret 配置：** - - 名称：`WEWORK_WEBHOOK_URL` - - 值：你的企业微信机器人 Webhook 地址 + **GitHub Secret 配置（⚠️ Name 名称必须严格一致）：** + - **Name（名称）**：`WEWORK_WEBHOOK_URL`（请复制粘贴此名称，不要手打，避免打错） + - **Secret（值）**：你的企业微信机器人 Webhook 地址
@@ -881,9 +892,9 @@ frequency_words.txt 文件增加了一个【必须词】功能，使用 + 号 👉 点击展开：飞书机器人（消息显示最友好）
- **GitHub Secret 配置：** - - 名称：`FEISHU_WEBHOOK_URL` - - 值：你的飞书机器人 Webhook 地址(该链接开头类似 https://www.feishu.cn/flow/api/trigger-webhook/********) + **GitHub Secret 配置（⚠️ Name 名称必须严格一致）：** + - **Name（名称）**：`FEISHU_WEBHOOK_URL`（请复制粘贴此名称，不要手打） + - **Secret（值）**：你的飞书机器人 Webhook 地址（该链接开头类似 https://www.feishu.cn/flow/api/trigger-webhook/********）
有两个方案，**方案一**配置简单，**方案二**配置复杂(但是稳定推送) @@ -970,9 +981,9 @@ frequency_words.txt 文件增加了一个【必须词】功能，使用 + 号 👉 点击展开：钉钉机器人
- **GitHub Secret 配置：** - - 名称：`DINGTALK_WEBHOOK_URL` - - 值：你的钉钉机器人 Webhook 地址 + **GitHub Secret 配置（⚠️ Name 名称必须严格一致）：** + - **Name（名称）**：`DINGTALK_WEBHOOK_URL`（请复制粘贴此名称，不要手打） + - **Secret（值）**：你的钉钉机器人 Webhook 地址
@@ -1000,9 +1011,14 @@ frequency_words.txt 文件增加了一个【必须词】功能，使用 + 号 👉 点击展开：Telegram Bot
- **GitHub Secret 配置：** - - 名称：`TELEGRAM_BOT_TOKEN` - 你的 Telegram Bot Token - - 名称：`TELEGRAM_CHAT_ID` - 你的 Telegram Chat ID + **GitHub Secret 配置（⚠️ Name 名称必须严格一致）：** + - **Name（名称）**：`TELEGRAM_BOT_TOKEN`（请复制粘贴此名称，不要手打） + - **Secret（值）**：你的 Telegram Bot Token + + - **Name（名称）**：`TELEGRAM_CHAT_ID`（请复制粘贴此名称，不要手打） + - **Secret（值）**：你的 Telegram Chat ID + + **说明**：Telegram 需要配置**两个** Secret，请分别点击两次"New repository secret"按钮添加
@@ -1039,12 +1055,23 @@ frequency_words.txt 文件增加了一个【必须词】功能，使用 + 号
- **GitHub Secret 配置：** - - 名称：`EMAIL_FROM` - 发件人邮箱地址 - - 名称：`EMAIL_PASSWORD` - 邮箱密码或授权码 - - 名称：`EMAIL_TO` - 收件人邮箱地址（多个收件人用英文逗号分隔）也可以和 EMAIL_FROM 一样，自己发送给自己 - - 名称：`EMAIL_SMTP_SERVER` - SMTP服务器地址（可选，留空则自动识别） - - 名称：`EMAIL_SMTP_PORT` - SMTP端口（可选，留空则自动识别） + **GitHub Secret 配置（⚠️ Name 名称必须严格一致）：** + - **Name（名称）**：`EMAIL_FROM`（请复制粘贴此名称，不要手打） + - **Secret（值）**：发件人邮箱地址 + + - **Name（名称）**：`EMAIL_PASSWORD`（请复制粘贴此名称，不要手打） + - **Secret（值）**：邮箱密码或授权码 + + - **Name（名称）**：`EMAIL_TO`（请复制粘贴此名称，不要手打） + - **Secret（值）**：收件人邮箱地址（多个收件人用英文逗号分隔，也可以和 EMAIL_FROM 一样，自己发送给自己） + + - **Name（名称）**：`EMAIL_SMTP_SERVER`（可选配置，请复制粘贴此名称） + - **Secret（值）**：SMTP服务器地址（可留空，系统会自动识别） + + - **Name（名称）**：`EMAIL_SMTP_PORT`（可选配置，请复制粘贴此名称） + - **Secret（值）**：SMTP端口（可留空，系统会自动识别） + + **说明**：邮件推送需要配置至少**3个必需** Secret（EMAIL_FROM、EMAIL_PASSWORD、EMAIL_TO），后两个为可选配置
@@ -1130,10 +1157,17 @@ frequency_words.txt 文件增加了一个【必须词】功能，使用 + 号 ❌ 坏例子：news、alerts（太容易被猜到） ``` - 3. **配置 GitHub Secret**： - - `NTFY_TOPIC`：填写你刚才订阅的主题名称 - - `NTFY_SERVER_URL`：留空（默认使用 ntfy.sh） - - `NTFY_TOKEN`：留空 + 3. **配置 GitHub Secret（⚠️ Name 名称必须严格一致）**： + - **Name（名称）**：`NTFY_TOPIC`（请复制粘贴此名称，不要手打） + - **Secret（值）**：填写你刚才订阅的主题名称 + + - **Name（名称）**：`NTFY_SERVER_URL`（可选配置，请复制粘贴此名称） + - **Secret（值）**：留空（默认使用 ntfy.sh） + + - **Name（名称）**：`NTFY_TOKEN`（可选配置，请复制粘贴此名称） + - **Secret（值）**：留空 + + **说明**：ntfy 至少需要配置 1 个必需 Secret (NTFY_TOPIC)，后两个为可选配置 4. **测试**： ```bash