Pārlūkot izejas kodu

docs: 更新文档

sansan 8 mēneši atpakaļ
vecāks
revīzija
0fc64f90e7
2 mainītis faili ar 39 papildinājumiem un 44 dzēšanām
  1. 6 7
      config/config.yaml
  2. 33 37
      readme.md

+ 6 - 7
config/config.yaml

@@ -1,10 +1,10 @@
 app:
   version_check_url: "https://raw.githubusercontent.com/sansan0/TrendRadar/refs/heads/master/version"
-  show_version_update: true # 控制显示版本更新提示,改成 false 将不接受新版本提示
+  show_version_update: true # 控制显示版本更新提示,如果 false,则不接受新版本提示
 
 crawler:
   request_interval: 1000 # 请求间隔(毫秒)
-  enable_crawler: true # 是否启用爬取新闻功能,false 时直接停止程序
+  enable_crawler: true # 是否启用爬取新闻功能,如果 false,则直接停止程序
   use_proxy: false # 是否启用代理,false 时为关闭
   default_proxy: "http://127.0.0.1:10086"
 
@@ -28,7 +28,7 @@ report:
   rank_threshold: 5 # 排名高亮阈值
 
 notification:
-  enable_notification: true # 是否启用通知功能,false 时不发送手机通知
+  enable_notification: true # 是否启用通知功能,如果 false,则不发送手机通知
   message_batch_size: 4000 # 消息分批大小(字节)(这个配置别动)
   batch_send_interval: 1 # 批次发送间隔(秒)
   feishu_message_separator: "━━━━━━━━━━━━━━━━━━━" # feishu 消息分割线
@@ -36,7 +36,7 @@ notification:
   silent_push:
     enabled: false  # 是否启用静默推送模式,如果 true,则启用
     # 因为我们白嫖的 github 服务器执行时间不稳定,所以时间范围要根据实际尽可能大一点,留足 2 小时
-    # 如果你想寻求稳定的按时的推送,建议部署在个人的服务器上
+    # 如果你想寻求稳定的按时的推送,建议通过 docker 部署在个人的服务器上
     time_range:
       start: "20:00"  # 推送时间范围开始(北京时间)
       end: "22:00"    # 推送时间范围结束(北京时间)
@@ -53,14 +53,13 @@ notification:
     telegram_bot_token: "" # Telegram Bot Token
     telegram_chat_id: "" # Telegram Chat ID
 
-# 用于让关注度更高的新闻在更前面显示,合起来是 1 就行
+# 用于让关注度更高的新闻在更前面显示,即用算法重新组合不同平台的热搜排序形成你侧重的热搜,合起来是 1 就行
 weight:
   rank_weight: 0.6 # 排名权重
   frequency_weight: 0.3 # 频次权重
   hotness_weight: 0.1 # 热度权重
 
-# 增加无聊的小知识
-# 这里的 name 你可以定义任意名称,只具有显示作用,不会影响数据的处理
+# name 可以定义任意名称,只具有显示作用,即使项目运行了几天后,忽然改掉 name 也不会影响代码的正常运行
 platforms:
   - id: "toutiao"
     name: "今日头条"

+ 33 - 37
readme.md

@@ -101,8 +101,6 @@
 
 **静默推送模式**:
 
-支持时间窗口控制,避免非工作时间的消息打扰:
-
 - **时间范围控制**:设定推送时间窗口(如 9:00-18:00),仅在指定时间内推送
 - **适用场景**:
   - 时间内每次执行都推送
@@ -174,28 +172,10 @@ GitHub 一键 Fork 即可使用,无需编程基础。
 
 ## 📝 更新日志
 
-<details>
-<summary><strong>👉 项目相关推荐</strong></summary>
-<br>
-
-> 附项目相关的两篇文章,欢迎留言交流
-
-- [2个月破 1000 star,我的GitHub项目推广实战经验](https://mp.weixin.qq.com/s/jzn0vLiQFX408opcfpPPxQ)
-- [基于本项目,如何开展公众号或者新闻资讯类文章写作](https://mp.weixin.qq.com/s/8ghyfDAtQZjLrnWTQabYOQ)
-
->**AI 开发:**
-- 如果你有小众需求,完全可以基于我的项目自行开发,零编程基础的也可以试试
-- 我所有的开源项目或多或少都使用了自己写的**AI辅助软件**来提升开发效率,这款工具已开源
-- **核心功能**:迅速筛选项目代码喂给AI,你只需要补充个人需求即可
-- **项目地址**:[https://github.com/sansan0/ai-code-context-helper](https://github.com/sansan0/ai-code-context-helper)
-
-</details>
-
 >**升级说明:** 
-- **注意**:请通过以下方式更新项目,不要通过 Sync fork 等方式更新
-- **小版本更新**:直接在 GitHub 网页编辑器中,用本项目的 `main.py` 代码替换你 fork 仓库中的对应文件 
+- **注意**:请通过以下方式更新项目(或根据**更新提示**升级),不要通过 Sync fork 更新
+- **小版本更新**:一般情况,直接在 GitHub 网页编辑器中,用本项目的 `main.py` 代码替换你 fork 仓库中的对应文件 
 - **大版本升级**:从 v1.x 升级到 v2.0 建议删除现有 fork 后重新 fork,这样更省力且避免配置冲突
-- **或者**:根据更新日志的特别说明升级
 
 ### 2025/08/30 - v2.1.0
 
@@ -215,9 +195,8 @@ GitHub 一键 Fork 即可使用,无需编程基础。
 - **推送频率可选**:时间段内支持单次推送或多次推送
 
 **更新提示**:
-- 本功能默认关闭,需手动开启
-- 在 config.yaml 中开启静默推送模式 
-- 同时更新 main.py 和 config.yaml
+- 本功能默认关闭,需手动在 config.yaml 中开启静默推送模式
+- 升级需同时更新 main.py 和 config.yaml 两个文件
 
 <details>
 <summary><strong>👉 历史更新</strong></summary>
@@ -479,22 +458,27 @@ frequency_words.txt 文件增加了一个【必须词】功能,使用 + 号
       - `TELEGRAM_CHAT_ID`:填入第 2 步获得的 Chat ID
    </details>
 
-3. **配置关键词和设置**:
+3. **主要配置**:
+
+    - **推送设置:** : 在 [config/config.yaml](config/config.yaml) 中进行,可根据里面的描述文字操作,这里不重复了
+    - 比如: 在 `config/config.yaml` 中修改 `report.mode` 设置:
 
-    - **关键词配置**: 修改 `config/frequency_words.txt` 文件,添加你关心的关键词
-    - **运行模式配置**: 在 `config/config.yaml` 中修改 `report.mode` 设置:
       | 模式 | 推送时机 | 显示内容 | 适用场景 |
         |------|----------|----------|----------|
         | **当日汇总模式**<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. **普通关键词** - 基础匹配
@@ -640,14 +624,9 @@ frequency_words.txt 文件增加了一个【必须词】功能,使用 + 号
     </details>
 
 
-4. **自动运行**:
-
-   - 项目已包含`.github/workflows/crawler.yml`配置文件,默认每小时运行一次
-   - 你也可以在 GitHub 仓库的 Actions 页面手动触发运行
+   
+    
 
-5. **查看结果**:
-   - 运行结果将自动保存在仓库的`output`目录中
-   - 同时通过配置的机器人发送通知到你的群组
 
 <details>
 <summary><strong>👉 自定义监控平台</strong></summary>
@@ -729,7 +708,24 @@ platforms:
 </div>
 
 <details>
-<summary><strong>👉 微信推送通知的折中方案</strong></summary>
+<summary><strong>👉 项目相关推荐</strong></summary>
+<br>
+
+> 附项目相关的两篇文章,欢迎留言交流
+
+- [2个月破 1000 star,我的GitHub项目推广实战经验](https://mp.weixin.qq.com/s/jzn0vLiQFX408opcfpPPxQ)
+- [基于本项目,如何开展公众号或者新闻资讯类文章写作](https://mp.weixin.qq.com/s/8ghyfDAtQZjLrnWTQabYOQ)
+
+>**AI 开发:**
+- 如果你有小众需求,完全可以基于我的项目自行开发,零编程基础的也可以试试
+- 我所有的开源项目或多或少都使用了自己写的**AI辅助软件**来提升开发效率,这款工具已开源
+- **核心功能**:迅速筛选项目代码喂给AI,你只需要补充个人需求即可
+- **项目地址**:[https://github.com/sansan0/ai-code-context-helper](https://github.com/sansan0/ai-code-context-helper)
+
+</details>
+
+<details>
+<summary><strong>👉 微信推送通知方案</strong></summary>
 <br>
 
 > 由于该方案是基于企业微信的插件机制,推送样式也十分不同,所以相关实现我暂时不准备纳入当前项目