Просмотр исходного кода

docs: 调整和增加文档说明

sansan 7 месяцев назад
Родитель
Сommit
de56fde2f1
1 измененных файлов с 184 добавлено и 184 удалено
  1. 184 184
      readme.md

+ 184 - 184
readme.md

@@ -23,14 +23,21 @@
 </div>
 
 
-> 本项目以轻量,易部署为目标
+> 本项目以轻量,易部署为目标。
+> 
+> 遇到问题可选择以下 2 种方式获得帮助,[点此跳转到两者的区别](#问题答疑与1元点赞)
 
 - **详细问题** → 选择 [GitHub Issues](https://github.com/sansan0/TrendRadar/issues),准备好截图和日志等。 
 - **快速咨询** → 选择【硅基茶水间】公众号文章留言或私信,尽量说清核心问题。
-- 遇到问题可选择以上 2 种方式获得帮助,[点此跳转到两者的区别](#问题答疑与1元点赞)
 
 <details>
-<summary>👉 点击查看<strong>致谢名单</strong> (当前 <strong>🔥23🔥</strong> 位)</summary>
+<summary>👉 点击查看<strong>致谢名单</strong> (当前 <strong>🔥24🔥</strong> 位)</summary>
+
+### 感谢
+
+- **fork 并为项目点 star** 的观众们,你们的认可是项目继续前进的动力
+- **关注公众号并积极互动** 的读者们,你们的留言和点赞让内容更有温度
+- **给予资金点赞支持** 的朋友们,你们的慷慨让项目得以持续发展
 
 ### 数据支持
 
@@ -50,6 +57,7 @@
 
 |           点赞人            |  金额  |  日期  |             备注             |
 | :-------------------------: | :----: | :----: | :-----------------------: |
+|           *椿           |  3  | 2025.9.23  |  加油,很不错         |
 |           *🍍           |  10  | 2025.9.21  |           |
 |           E*f           |  1  | 2025.9.20  |           |
 |           *记            |  1  | 2025.9.20  |           |
@@ -118,10 +126,11 @@ platforms:
 
 **三种推送模式**:
 
-- **📈 投资者/交易员** → 选择 `incremental`,及时获取新增资讯
-- **📰 自媒体人/内容创作者** → 选择 `current`,掌握实时热点趋势  
-- **📋 企业管理者/普通用户** → 选择 `daily`,定时获取完整日报
-
+| 模式 | 适用人群 | 推送时机 | 显示内容 | 适用场景 |
+|------|----------|----------|----------|----------|
+| **当日汇总模式**<br/>`daily` | 📋 企业管理者/普通用户 | 按时推送 | 当日所有匹配新闻<br/>+ 新增新闻区域 | 日报总结<br/>全面了解当日热点趋势 |
+| **当前榜单模式**<br/>`current` | 📰 自媒体人/内容创作者 | 按时推送 | 当前榜单匹配新闻<br/>+ 新增新闻区域 | 实时热点追踪<br/>了解当前最火的内容 |
+| **增量监控模式**<br/>`incremental` | 📈 投资者/交易员 | 有新增才推送 | 新出现的匹配频率词新闻 | 避免重复信息干扰<br/>高频监控场景 |
 
 **静默推送模式**:
 
@@ -134,11 +143,169 @@ platforms:
 
 设置个人关键词(如:AI、比亚迪、教育政策),只推送相关热点,过滤无关信息
 
-- 支持普通词、必须词(+)、过滤词(!)三种语法,具体见【frequency_words.txt 配置教程】
+- 支持普通词、必须词(+)、过滤词(!)三种语法,见【frequency_words.txt 配置教程】
 - 词组化管理,独立统计不同主题热点
 
 > 也可以不做筛选,完整的推送所有热点,具体见【历史更新】中的 v2.0.1
 
+<details>
+<summary><strong>👉 frequency_words.txt 配置教程</strong></summary>
+<br>
+
+在 `frequency_words.txt` 文件中配置监控的关键词,支持三种语法和词组功能。
+
+关键词越靠前,新闻的优先级越高,你可以根据自己的关注度调整关键词顺序
+
+| 语法类型 | 符号 | 作用 | 示例 | 匹配逻辑 |
+|---------|------|------|------|---------|
+| **普通词** | 无 | 基础匹配 | `华为` | 包含任意一个即可 |
+| **必须词** | `+` | 限定范围 | `+手机` | 必须同时包含 |
+| **过滤词** | `!` | 排除干扰 | `!广告` | 包含则直接排除 |
+
+### 📋 基础语法说明
+
+#### 1. **普通关键词** - 基础匹配
+```txt
+华为
+OPPO
+苹果
+```
+**作用:** 新闻标题包含其中**任意一个词**就会被捕获
+
+#### 2. **必须词** `+词汇` - 限定范围  
+```txt
+华为
+OPPO
++手机
+```
+**作用:** 必须同时包含普通词**和**必须词才会被捕获
+
+#### 3. **过滤词** `!词汇` - 排除干扰
+```txt
+苹果
+华为
+!水果
+!价格
+```
+**作用:** 包含过滤词的新闻会被**直接排除**,即使包含关键词
+
+### 🔗 词组功能 - 空行分隔的重要作用
+
+**核心规则:** 用**空行**分隔不同的词组,每个词组独立统计
+
+#### 示例配置:
+```txt
+iPhone
+华为
+OPPO
++发布
+
+A股
+上证
+深证
++涨跌
+!预测
+
+世界杯
+欧洲杯
+亚洲杯
++比赛
+```
+
+#### 词组解释及匹配效果:
+
+**第1组 - 手机新品类:**
+- 关键词:iPhone、华为、OPPO
+- 必须词:发布
+- 效果:必须包含手机品牌名,同时包含"发布"
+
+**匹配示例:**
+- ✅ "iPhone 15正式发布售价公布" ← 有"iPhone"+"发布"
+- ✅ "华为Mate60系列发布会直播" ← 有"华为"+"发布"
+- ✅ "OPPO Find X7发布时间确定" ← 有"OPPO"+"发布"
+- ❌ "iPhone销量创新高" ← 有"iPhone"但缺少"发布"
+
+**第2组 - 股市行情类:**  
+- 关键词:A股、上证、深证
+- 必须词:涨跌
+- 过滤词:预测
+- 效果:包含股市相关词,同时包含"涨跌",但排除包含"预测"的内容
+
+**匹配示例:**
+- ✅ "A股今日大幅涨跌分析" ← 有"A股"+"涨跌"
+- ✅ "上证指数涨跌原因解读" ← 有"上证"+"涨跌"
+- ❌ "专家预测A股涨跌趋势" ← 有"A股"+"涨跌"但包含"预测"
+- ❌ "A股成交量创新高" ← 有"A股"但缺少"涨跌"
+
+**第3组 - 足球赛事类:**
+- 关键词:世界杯、欧洲杯、亚洲杯
+- 必须词:比赛
+- 效果:必须包含杯赛名称,同时包含"比赛"
+
+**匹配示例:**
+- ✅ "世界杯小组赛比赛结果" ← 有"世界杯"+"比赛"
+- ✅ "欧洲杯决赛比赛时间" ← 有"欧洲杯"+"比赛"
+- ❌ "世界杯门票开售" ← 有"世界杯"但缺少"比赛"
+
+### 🎯 配置技巧
+
+#### 1. **从宽到严的配置策略**
+```txt
+# 第一步:先用宽泛关键词测试
+人工智能
+AI
+ChatGPT
+
+# 第二步:发现误匹配后,加入必须词限定
+人工智能  
+AI
+ChatGPT
++技术
+
+# 第三步:发现干扰内容后,加入过滤词
+人工智能
+AI  
+ChatGPT
++技术
+!广告
+!培训
+```
+
+#### 2. **避免过度复杂**
+❌ **不推荐:** 一个词组包含太多词汇
+```txt
+华为
+OPPO
+苹果
+三星
+vivo
+一加
+魅族
++手机
++发布
++销量
+!假货
+!维修
+!二手
+```
+
+✅ **推荐:** 拆分成多个精确的词组
+```txt
+华为
+OPPO
++新品
+
+苹果
+三星  
++发布
+
+手机
+销量
++市场
+```
+
+</details>
+
 ### **个性化热点算法**
 
 不再被各个平台的算法牵着走,TrendRadar 会重新整理全网热搜:
@@ -288,13 +455,7 @@ GitHub 一键 Fork 即可使用,无需编程基础。
 - **小版本更新**:从 v2.x 升级到 v2.y, 用本项目的 `main.py` 代码替换你 fork 仓库中的对应文件 
 - **大版本升级**:从 v1.x 升级到 v2.y, 建议删除现有 fork 后重新 fork,这样更省力且避免配置冲突
 
-
-> **感谢**:
-- **fork 并为项目点 star** 的观众们,你们的认可是我前进的动力
-- **关注公众号并积极互动** 的读者们,你们的留言和点赞让内容更有温度
-- **给予资金点赞支持** 的朋友们,你们的慷慨让项目得以持续发展
-> 
-> 下一次**新功能**,大概会是 ai 分析功能(●'◡'●)
+> 挖坑:下一次**新功能**,大概会是 ai 分析功能(●'◡'●)
 
 ### 2025/09/22 - v2.3.1
 
@@ -303,17 +464,14 @@ GitHub 一键 Fork 即可使用,无需编程基础。
 - **HTML 精美格式**:邮件内容采用与网页版相同的 HTML 格式,排版精美,移动端适配
 - **批量发送支持**:支持多个收件人,用逗号分隔即可同时发送给多人
 - **自定义 SMTP**:可自定义 SMTP 服务器和端口
+- 修复Docker构建网络连接问题
 
 **使用说明**:
 - 适用场景:适合需要邮件归档、团队分享、定时报告的用户
-- 注意事项:为防止邮件群发功能被**滥用**,当前的群发是所有收件人都能看到彼此的邮箱地址,适合熟人间交流资讯
-
-**支持的邮箱服务**:
-- Gmail、QQ邮箱、Outlook/Hotmail、163/126邮箱、新浪邮箱、搜狐邮箱等
+- 支持邮箱:Gmail、QQ邮箱、Outlook/Hotmail、163/126邮箱、新浪邮箱、搜狐邮箱等
 
 **更新提示**:
-- 此次更新的内容比较多,建议删除原有 fork, 重新 fork 并配置
-
+- 此次更新的内容比较多,如果想升级,建议采用【大版本升级】
 
 <details>
 <summary><strong>👉 历史更新</strong></summary>
@@ -649,171 +807,13 @@ frequency_words.txt 文件增加了一个【必须词】功能,使用 + 号
 
    </details>
 
-3. **主要配置**:
+3. **配置说明:**:
 
-    - **推送设置:** : 在 [config/config.yaml](config/config.yaml) 中进行,可根据里面的描述文字操作,这里不重复了
-    - 比如: 在 `config/config.yaml` 中修改 `report.mode` 设置:
+    - **推送设置**:在 [config/config.yaml](config/config.yaml) 中配置推送模式和通知选项
+    - **关键词设置**:在 [config/frequency_words.txt](config/frequency_words.txt) 中添加你关心的关键词
 
-      | 模式 | 推送时机 | 显示内容 | 适用场景 |
-        |------|----------|----------|----------|
-        | **当日汇总模式**<br/>`daily` | 按时推送 | 当日所有匹配新闻<br/>+ 新增新闻区域 | 日报总结<br/>全面了解当日热点趋势 |
-        | **当前榜单模式**<br/>`current` | 按时推送 | 当前榜单匹配新闻<br/>+ 新增新闻区域 | 实时热点追踪<br/>了解当前最火的内容 |
-        | **增量监控模式**<br/>`incremental` | 有新增才推送 | 新出现的匹配频率词新闻 | 避免重复信息干扰<br/>高频监控场景 |
-
-    - **关键词配置**: 修改 [config/frequency_words.txt](config/frequency_words.txt) 文件,添加你关心的关键词
+    **注意**:建议只调整文档中明确说明的配置项,其他选项主要供开发和测试使用。
     
-    <details>
-    <summary><strong>👉 frequency_words.txt 配置教程</strong></summary>
-    <br>
-
-    在 `frequency_words.txt` 文件中配置监控的关键词,支持三种语法和词组功能。
-
-    关键词越靠前,新闻的优先级越高,你可以根据自己的关注度调整关键词顺序
-
-    ### 📋 基础语法说明
-
-    #### 1. **普通关键词** - 基础匹配
-    ```txt
-    华为
-    OPPO
-    苹果
-    ```
-    **作用:** 新闻标题包含其中**任意一个词**就会被捕获
-
-    #### 2. **必须词** `+词汇` - 限定范围  
-    ```txt
-    华为
-    OPPO
-    +手机
-    ```
-    **作用:** 必须同时包含普通词**和**必须词才会被捕获
-
-    #### 3. **过滤词** `!词汇` - 排除干扰
-    ```txt
-    苹果
-    华为
-    !水果
-    !价格
-    ```
-    **作用:** 包含过滤词的新闻会被**直接排除**,即使包含关键词
-
-    ### 🔗 词组功能 - 空行分隔的重要作用
-
-    **核心规则:** 用**空行**分隔不同的词组,每个词组独立统计
-
-    #### 示例配置:
-    ```txt
-    iPhone
-    华为
-    OPPO
-    +发布
-
-    A股
-    上证
-    深证
-    +涨跌
-    !预测
-
-    世界杯
-    欧洲杯
-    亚洲杯
-    +比赛
-    ```
-
-    #### 词组解释及匹配效果:
-
-    **第1组 - 手机新品类:**
-    - 关键词:iPhone、华为、OPPO
-    - 必须词:发布
-    - 效果:必须包含手机品牌名,同时包含"发布"
-
-    **匹配示例:**
-    - ✅ "iPhone 15正式发布售价公布" ← 有"iPhone"+"发布"
-    - ✅ "华为Mate60系列发布会直播" ← 有"华为"+"发布"
-    - ✅ "OPPO Find X7发布时间确定" ← 有"OPPO"+"发布"
-    - ❌ "iPhone销量创新高" ← 有"iPhone"但缺少"发布"
-
-    **第2组 - 股市行情类:**  
-    - 关键词:A股、上证、深证
-    - 必须词:涨跌
-    - 过滤词:预测
-    - 效果:包含股市相关词,同时包含"涨跌",但排除包含"预测"的内容
-
-    **匹配示例:**
-    - ✅ "A股今日大幅涨跌分析" ← 有"A股"+"涨跌"
-    - ✅ "上证指数涨跌原因解读" ← 有"上证"+"涨跌"
-    - ❌ "专家预测A股涨跌趋势" ← 有"A股"+"涨跌"但包含"预测"
-    - ❌ "A股成交量创新高" ← 有"A股"但缺少"涨跌"
-
-    **第3组 - 足球赛事类:**
-    - 关键词:世界杯、欧洲杯、亚洲杯
-    - 必须词:比赛
-    - 效果:必须包含杯赛名称,同时包含"比赛"
-
-    **匹配示例:**
-    - ✅ "世界杯小组赛比赛结果" ← 有"世界杯"+"比赛"
-    - ✅ "欧洲杯决赛比赛时间" ← 有"欧洲杯"+"比赛"
-    - ❌ "世界杯门票开售" ← 有"世界杯"但缺少"比赛"
-
-    ### 🎯 配置技巧
-
-    #### 1. **从宽到严的配置策略**
-    ```txt
-    # 第一步:先用宽泛关键词测试
-    人工智能
-    AI
-    ChatGPT
-
-    # 第二步:发现误匹配后,加入必须词限定
-    人工智能  
-    AI
-    ChatGPT
-    +技术
-
-    # 第三步:发现干扰内容后,加入过滤词
-    人工智能
-    AI  
-    ChatGPT
-    +技术
-    !广告
-    !培训
-    ```
-
-    #### 2. **避免过度复杂**
-    ❌ **不推荐:** 一个词组包含太多词汇
-    ```txt
-    华为
-    OPPO
-    苹果
-    三星
-    vivo
-    一加
-    魅族
-    +手机
-    +发布
-    +销量
-    !假货
-    !维修
-    !二手
-    ```
-
-    ✅ **推荐:** 拆分成多个精确的词组
-    ```txt
-    华为
-    OPPO
-    +新品
-
-    苹果
-    三星  
-    +发布
-
-    手机
-    销量
-    +市场
-    ```
-
-    </details>
-
 
 
 <details>
@@ -1015,7 +1015,7 @@ docker exec -it trend-radar ls -la /app/config/
 
 ## ☕问题答疑与1元点赞
 
-> 心意到就行,收到的**点赞**用于提高开发者开源的积极性。你们的**点赞**已记录于最顶部的【致谢名单】
+> 心意到就行,收到的**点赞**用于提高开发者开源的积极性。你们的**点赞**已记录于最顶部的**致谢名单**
 
 |公众号关注 |微信点赞 | 支付宝点赞 |
 |:---:|:---:|:---:|