mirror of
https://gitee.com/houhuan/TrendRadar.git
synced 2025-12-21 11:17:15 +08:00
docs: 优化文档显示
This commit is contained in:
sansan
parent
b794bdd358
commit
c3e182941a
56
README-EN.md
56
README-EN.md
@ -8,8 +8,8 @@
|
||||
|
||||
<a href="https://trendshift.io/repositories/14726" target="_blank"><img src="https://trendshift.io/api/badge/repositories/14726" alt="sansan0%2FTrendRadar | Trendshift" style="width: 250px; height: 55px;" width="250" height="55"/></a>
|
||||
|
||||
<a href="https://share.302.ai/mEOUzG" target="_blank" title="One-stop AI Models & APIs Platform"><img src="_image/302ai.png" alt="302.AI logo" height="52"/></a>
|
||||
<a href="https://shandianshuo.cn" target="_blank" title="AI Voice Input, 4x Faster Than Typing ⚡"><img src="_image/shandianshuo.png" alt="FlashSpeak logo" height="53"/></a>
|
||||
<a href="https://share.302.ai/mEOUzG" target="_blank" title="One-stop AI Models & APIs Platform"><img src="_image/302ai.png" alt="302.AI logo" height="50"/></a>
|
||||
<a href="https://shandianshuo.cn" target="_blank" title="AI Voice Input, 4x Faster Than Typing ⚡"><img src="_image/shandianshuo.png" alt="FlashSpeak logo" height="51"/></a>
|
||||
|
||||
[](https://github.com/sansan0/TrendRadar/stargazers)
|
||||
[](https://github.com/sansan0/TrendRadar/network/members)
|
||||
@ -43,13 +43,15 @@
|
||||
|
||||
> This project is designed to be lightweight and easy to deploy
|
||||
|
||||
<br>
|
||||
|
||||
## 📑 Quick Navigation
|
||||
|
||||
<div align="center">
|
||||
|
||||
| [🚀 Quick Start](#-quick-start) | [🤖 AI Analysis](#-ai-analysis) | [⚙️ Configuration Guide](#configuration-guide) | [📝 Changelog](#-changelog) | [❓ FAQ & Support](#-faq--support) |
|
||||
|:---:|:---:|:---:|:---:|:---:|
|
||||
| [🐳 Docker Deployment](#-docker-deployment) | [🔌 MCP Clients](#-mcp-clients) | [⭐ Related Projects](#-related-projects) | [🪄 Sponsors](#-sponsors) | |
|
||||
| [🐳 Docker Deployment](#6-docker-deployment) | [🔌 MCP Clients](#-mcp-clients) | [📚 Related Projects](#-related-projects) | [🪄 Sponsors](#-sponsors) | |
|
||||
|
||||
</div>
|
||||
|
||||
@ -113,6 +115,7 @@ After communication, the author indicated no concerns about server pressure, but
|
||||
|
||||
</details>
|
||||
|
||||
<br>
|
||||
|
||||
## ✨ Core Features
|
||||
|
||||
@ -256,6 +259,7 @@ Transform from "algorithm recommendation captivity" to "actively getting the inf
|
||||
|:---:|:---:|
|
||||
|  |  |
|
||||
|
||||
<br>
|
||||
|
||||
## 📝 Changelog
|
||||
|
||||
@ -629,6 +633,7 @@ frequency_words.txt file added **required word** feature, using + sign
|
||||
|
||||
</details>
|
||||
|
||||
<br>
|
||||
|
||||
## 🚀 Quick Start
|
||||
|
||||
@ -1106,8 +1111,8 @@ frequency_words.txt file added **required word** feature, using + sign
|
||||
|
||||
> 💡 Default configuration works normally, only adjust if you need personalization
|
||||
|
||||
- **Push Settings**: Configure push mode and notification options in [config/config.yaml](config/config.yaml)
|
||||
- **Keyword Settings**: Add your interested keywords in [config/frequency_words.txt](config/frequency_words.txt)
|
||||
- **Push Settings**: Configure push mode and notification options in [config/config.yaml](config/config.yaml) → [Push Mode Details](#3-push-mode-details)
|
||||
- **Keyword Settings**: Add your interested keywords in [config/frequency_words.txt](config/frequency_words.txt) → [Keyword Configuration Tutorial](#2-keyword-configuration)
|
||||
- **Push Frequency Adjustment**: In [.github/workflows/crawler.yml](.github/workflows/crawler.yml) adjust carefully, don't be greedy
|
||||
|
||||
**Note**: Suggest only adjusting explicitly documented config items, other options mainly for author's development testing
|
||||
@ -1137,6 +1142,7 @@ frequency_words.txt file added **required word** feature, using + sign
|
||||
|
||||
👉 **Learn More**: [AI Analysis](#-ai-analysis) — Unlock hidden capabilities and make trend tracking more efficient!
|
||||
|
||||
<br>
|
||||
|
||||
<a name="configuration-guide"></a>
|
||||
|
||||
@ -1439,6 +1445,22 @@ Assume you monitor "Apple" keyword, execute once per hour:
|
||||
> - **Reason**: You might have selected `daily` (Daily Summary) or `current` (Current Rankings) mode
|
||||
> - **Solution**: Change to `incremental` (Incremental Monitor) mode, only push new content
|
||||
|
||||
#### ⚠️ Incremental Mode Important Notice
|
||||
|
||||
> **Users who selected `incremental` (Incremental Monitor) mode, please note:**
|
||||
>
|
||||
> 📌 **Incremental mode only pushes when there are new matching news**
|
||||
>
|
||||
> **If you haven't received push notifications for a long time, it may be because:**
|
||||
> 1. No new hot topics matching your keywords in current time period
|
||||
> 2. Keyword configuration is too strict or too broad
|
||||
> 3. Too few monitoring platforms
|
||||
>
|
||||
> **Solutions:**
|
||||
> - Solution 1: 👉 [Optimize Keyword Configuration](#2-keyword-configuration) - Adjust keyword precision, add or modify monitoring keywords
|
||||
> - Solution 2: Switch push mode - Change to `current` or `daily` mode for scheduled push notifications
|
||||
> - Solution 3: 👉 [Add More Platforms](#1-platform-configuration) - Add more news platforms to expand information sources
|
||||
|
||||
</details>
|
||||
|
||||
### 4. Advanced Configuration - Hotspot Weight Adjustment
|
||||
@ -1538,7 +1560,11 @@ Updated: 2025-01-15 12:30:15
|
||||
</details>
|
||||
|
||||
|
||||
## 🐳 Docker Deployment
|
||||
### 6. Docker Deployment
|
||||
|
||||
<details>
|
||||
<summary>👉 Click to expand: <strong>Complete Docker Deployment Guide</strong></summary>
|
||||
<br>
|
||||
|
||||
#### Method 1: Quick Experience (One-Line Command)
|
||||
|
||||
@ -1738,6 +1764,9 @@ docker exec -it trend-radar /bin/bash
|
||||
docker exec -it trend-radar ls -la /app/config/
|
||||
```
|
||||
|
||||
</details>
|
||||
|
||||
<br>
|
||||
|
||||
## 🤖 AI Analysis
|
||||
|
||||
@ -1781,10 +1810,17 @@ Cherry Studio provides GUI config interface, 5-minute quick deployment, complex
|
||||
|
||||
**Question Effect**:
|
||||
|
||||
> Actually not recommended to ask multiple questions at once. If your chosen AI model cannot even sequentially call as shown below, suggest switching models.
|
||||
<details>
|
||||
<summary>👉 Click to expand: <strong>View AI Conversation Example</strong></summary>
|
||||
<br>
|
||||
|
||||
> 💡 **Tip**: Actually not recommended to ask multiple questions at once. If your chosen AI model cannot even sequentially call as shown below, suggest switching models.
|
||||
|
||||
<img src="/_image/ai3.png" alt="MCP usage effect" width="600">
|
||||
|
||||
</details>
|
||||
|
||||
<br>
|
||||
|
||||
## 🔌 MCP Clients
|
||||
|
||||
@ -2078,6 +2114,7 @@ Any client supporting Model Context Protocol can connect to TrendRadar:
|
||||
|
||||
</details>
|
||||
|
||||
<br>
|
||||
|
||||
## ☕ FAQ & Support
|
||||
|
||||
@ -2250,7 +2287,9 @@ A: You can top up as needed, pay-as-you-go. Major AI model prices are now relati
|
||||
|
||||
</details>
|
||||
|
||||
### Project Articles
|
||||
<br>
|
||||
|
||||
## 📚 Related Projects
|
||||
|
||||
> **4 Related Articles** (Chinese):
|
||||
|
||||
@ -2329,6 +2368,7 @@ flowchart TD
|
||||
|
||||
[](https://www.star-history.com/#sansan0/TrendRadar&Date)
|
||||
|
||||
<br>
|
||||
|
||||
## 📄 License
|
||||
|
||||
|
||||
69
README.md
69
README.md
@ -8,8 +8,8 @@
|
||||
|
||||
<a href="https://trendshift.io/repositories/14726" target="_blank"><img src="https://trendshift.io/api/badge/repositories/14726" alt="sansan0%2FTrendRadar | Trendshift" style="width: 250px; height: 55px;" width="250" height="55"/></a>
|
||||
|
||||
<a href="https://share.302.ai/mEOUzG" target="_blank" title="一站式 AI 模型和 API 平台"><img src="_image/302ai.png" alt="302.AI logo" height="52"/></a>
|
||||
<a href="https://shandianshuo.cn" target="_blank" title="AI 语音输入，比打字快 4 倍 ⚡"><img src="_image/shandianshuo.png" alt="闪电说 logo" height="53"/></a>
|
||||
<a href="https://share.302.ai/mEOUzG" target="_blank" title="一站式 AI 模型和 API 平台"><img src="_image/302ai.png" alt="302.AI logo" height="50"/></a>
|
||||
<a href="https://shandianshuo.cn" target="_blank" title="AI 语音输入，比打字快 4 倍 ⚡"><img src="_image/shandianshuo.png" alt="闪电说 logo" height="51"/></a>
|
||||
|
||||
[](https://github.com/sansan0/TrendRadar/stargazers)
|
||||
[](https://github.com/sansan0/TrendRadar/network/members)
|
||||
@ -60,13 +60,15 @@
|
||||
|
||||
</details>
|
||||
|
||||
<br>
|
||||
|
||||
## 📑 快速导航
|
||||
|
||||
<div align="center">
|
||||
|
||||
| [🚀 快速开始](#-快速开始) | [🤖 AI 智能分析](#-ai-智能分析) | [⚙️ 配置详解](#配置详解) | [📝 更新日志](#-更新日志) | [❓ 答疑与交流](#问题答疑与交流) |
|
||||
|:---:|:---:|:---:|:---:|:---:|
|
||||
| [🐳 Docker部署](#-docker-部署) | [🔌 MCP客户端](#-mcp-客户端) | [⭐ 项目相关](#项目相关) | [🪄 赞助商](#-赞助商) | |
|
||||
| [🐳 Docker部署](#6-docker-部署) | [🔌 MCP客户端](#-mcp-客户端) | [📚 项目相关](#-项目相关) | [🪄 赞助商](#-赞助商) | |
|
||||
|
||||
</div>
|
||||
|
||||
@ -75,7 +77,7 @@
|
||||
- 感谢**关注[公众号](#问题答疑与交流)** 的读者们，你们的留言、点赞、分享和推荐等积极互动让内容更有温度😎。
|
||||
|
||||
<details>
|
||||
<summary>👉 点击展开：<strong>致谢名单</strong> (当前 <strong>🔥72🔥</strong> 位)</summary>
|
||||
<summary>👉 点击展开：<strong>致谢名单</strong> (当前 <strong>🔥73🔥</strong> 位)</summary>
|
||||
|
||||
### 基础设施支持
|
||||
|
||||
@ -102,9 +104,12 @@
|
||||
> 感谢**给予资金支持**的朋友们，你们的慷慨已化身为键盘旁的零食饮料，陪伴着项目的每一次迭代。
|
||||
>
|
||||
> **"一元点赞"已暂停**，如仍想支持作者，可前往[公众号](#问题答疑与交流)文章底部点击"喜欢作者"。
|
||||
>
|
||||
> 一位可爱猫头像的朋友，不知你从哪个角落翻到了我的收款码，三连了 1.8，心意已收到，感谢厚爱
|
||||
|
||||
| 点赞人 | 金额 | 日期 | 备注 |
|
||||
| :-------------------------: | :----: | :----: | :-----------------------: |
|
||||
| D*5 | 1.8 * 3 | 2025.11.24 | |
|
||||
| *鬼 | 1 | 2025.11.17 | |
|
||||
| *超 | 10 | 2025.11.17 | |
|
||||
| R*w | 10 | 2025.11.17 | 这 agent 做的牛逼啊,兄弟 |
|
||||
@ -177,6 +182,7 @@
|
||||
|
||||
</details>
|
||||
|
||||
<br>
|
||||
|
||||
## ✨ 核心功能
|
||||
|
||||
@ -319,6 +325,7 @@ GitHub 一键 Fork 即可使用，无需编程基础。
|
||||
|:---:|:---:|
|
||||
|  |  |
|
||||
|
||||
<br>
|
||||
|
||||
## 📝 更新日志
|
||||
|
||||
@ -679,6 +686,7 @@ frequency_words.txt 文件增加了一个【必须词】功能，使用 + 号
|
||||
|
||||
</details>
|
||||
|
||||
<br>
|
||||
|
||||
## 🚀 快速开始
|
||||
|
||||
@ -1209,8 +1217,8 @@ frequency_words.txt 文件增加了一个【必须词】功能，使用 + 号
|
||||
|
||||
> 💡 默认配置已可正常使用，如需个性化调整，可参考以下选项
|
||||
|
||||
- **推送设置**：在 [config/config.yaml](config/config.yaml) 中配置推送模式和通知选项
|
||||
- **关键词设置**：在 [config/frequency_words.txt](config/frequency_words.txt) 中添加你关心的关键词
|
||||
- **推送设置**：在 [config/config.yaml](config/config.yaml) 中配置推送模式和通知选项 → [推送模式详解](#3-推送模式详解)
|
||||
- **关键词设置**：在 [config/frequency_words.txt](config/frequency_words.txt) 中添加你关心的关键词 → [关键词配置教程](#2-关键词配置)
|
||||
- **推送频率调整**：在 [.github/workflows/crawler.yml](.github/workflows/crawler.yml) 请谨慎调整，别贪心
|
||||
|
||||
**注意**：建议只调整文档中明确说明的配置项,其他选项主要供作者开发时测试使用
|
||||
@ -1240,6 +1248,7 @@ frequency_words.txt 文件增加了一个【必须词】功能，使用 + 号
|
||||
|
||||
👉 **了解更多**：[AI 智能分析](#-ai-智能分析) — 解锁项目的隐藏能力，让热点追踪更高效！
|
||||
|
||||
<br>
|
||||
|
||||
<a name="配置详解"></a>
|
||||
|
||||
@ -1539,6 +1548,22 @@ report:
|
||||
> - **原因**：你可能选择了 `daily`（当日汇总）或 `current`（当前榜单）模式
|
||||
> - **解决**：改用 `incremental`（增量监控）模式，只推送新增内容
|
||||
|
||||
#### ⚠️ 增量模式重要提示
|
||||
|
||||
> **选择了 `incremental`（增量监控）模式的用户请注意：**
|
||||
>
|
||||
> 📌 **增量模式只在有新增匹配新闻时才会推送**
|
||||
>
|
||||
> **如果长时间没有收到推送，可能是因为：**
|
||||
> 1. 当前时段没有符合你关键词的新热点出现
|
||||
> 2. 关键词配置过于严格或过于宽泛
|
||||
> 3. 监控平台数量较少
|
||||
>
|
||||
> **解决方案：**
|
||||
> - 方案1：👉 [优化关键词配置](#2-关键词配置) - 调整关键词的精准度，增加或修改监控词汇
|
||||
> - 方案2：切换推送模式 - 改用 `current` 或 `daily` 模式，可以定时接收推送
|
||||
> - 方案3：👉 [增加监控平台](#1-平台配置) - 添加更多新闻平台，扩大信息来源
|
||||
|
||||
</details>
|
||||
|
||||
### 4. 热点权重调整
|
||||
@ -1638,7 +1663,11 @@ weight:
|
||||
</details>
|
||||
|
||||
|
||||
## 🐳 Docker 部署
|
||||
### 6. Docker 部署
|
||||
|
||||
<details>
|
||||
<summary>👉 点击展开：<strong>Docker 部署完整指南</strong></summary>
|
||||
<br>
|
||||
|
||||
#### 方式一：快速体验（一行命令）
|
||||
|
||||
@ -1688,11 +1717,11 @@ docker run -d --name trend-radar \
|
||||
# 创建目录结构
|
||||
mkdir -p trendradar/{config,docker}
|
||||
cd trendradar
|
||||
|
||||
|
||||
# 下载配置文件模板
|
||||
wget https://raw.githubusercontent.com/sansan0/TrendRadar/master/config/config.yaml -P config/
|
||||
wget https://raw.githubusercontent.com/sansan0/TrendRadar/master/config/frequency_words.txt -P config/
|
||||
|
||||
|
||||
# 下载 docker-compose 配置
|
||||
wget https://raw.githubusercontent.com/sansan0/TrendRadar/master/docker/.env
|
||||
wget https://raw.githubusercontent.com/sansan0/TrendRadar/master/docker/docker-compose.yml
|
||||
@ -1747,7 +1776,7 @@ docker run -d --name trend-radar \
|
||||
```bash
|
||||
# 查看日志
|
||||
docker logs -f trend-radar
|
||||
|
||||
|
||||
# 查看容器状态
|
||||
docker ps | grep trend-radar
|
||||
```
|
||||
@ -1838,6 +1867,9 @@ docker exec -it trend-radar /bin/bash
|
||||
docker exec -it trend-radar ls -la /app/config/
|
||||
```
|
||||
|
||||
</details>
|
||||
|
||||
<br>
|
||||
|
||||
## 🤖 AI 智能分析
|
||||
|
||||
@ -1865,7 +1897,6 @@ AI 分析功能**不是**直接查询网络实时数据，而是分析你**本
|
||||
- 按照 [快速开始](#-快速开始) 部署运行项目
|
||||
- 等待至少 1 天积累新闻数据后，即可查询最新热点
|
||||
|
||||
---
|
||||
|
||||
### 1. 快速部署
|
||||
|
||||
@ -1881,10 +1912,17 @@ Cherry Studio 提供 GUI 配置界面， 5 分钟快速部署， 复杂的部分
|
||||
|
||||
**提问效果**：
|
||||
|
||||
> 实际不建议一次性问多个问题。如果你选择的 ai 模型连下图的按顺序调用都无法做到，建议换一个。
|
||||
<details>
|
||||
<summary>👉 点击展开：<strong>查看 AI 对话示例图</strong></summary>
|
||||
<br>
|
||||
|
||||
> 💡 **提示**：实际不建议一次性问多个问题。如果你选择的 AI 模型连下图的按顺序调用都无法做到，建议换一个。
|
||||
|
||||
<img src="/_image/ai3.png" alt="mcp 使用效果图" width="600">
|
||||
|
||||
</details>
|
||||
|
||||
<br>
|
||||
|
||||
## 🔌 MCP 客户端
|
||||
|
||||
@ -2260,6 +2298,7 @@ MCP Inspector 是官方调试工具，用于测试 MCP 连接：
|
||||
|
||||
</details>
|
||||
|
||||
<br>
|
||||
|
||||
## ☕问题答疑与交流
|
||||
|
||||
@ -2282,7 +2321,6 @@ MCP Inspector 是官方调试工具，用于测试 MCP 连接：
|
||||
|
||||
<br>
|
||||
|
||||
---
|
||||
|
||||
## 🪄 赞助商
|
||||
|
||||
@ -2347,7 +2385,9 @@ A: 可以按需充值，按量付费。目前大厂模型价格已相对亲民
|
||||
|
||||
---
|
||||
|
||||
### 项目相关
|
||||
<br>
|
||||
|
||||
## 📚 项目相关
|
||||
|
||||
> **4 篇文章**：
|
||||
|
||||
@ -2426,6 +2466,7 @@ flowchart TD
|
||||
|
||||
[](https://www.star-history.com/#sansan0/TrendRadar&Date)
|
||||
|
||||
<br>
|
||||
|
||||
## 📄 许可证
|
||||
|
||||
|
||||
Loading…
Reference in New Issue
Block a user