Skip to content

Commit 9e02f3f

Browse files
authored
docs: tidy README presentation (#1259)
1 parent 6c5a17a commit 9e02f3f

4 files changed

Lines changed: 32 additions & 62 deletions

File tree

README.md

Lines changed: 11 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@
1515

1616
> 🤖 基于 AI 大模型的 A股/港股/美股自选股智能分析系统,每日自动分析并推送「决策仪表盘」到企业微信/飞书/Telegram/Discord/Slack/邮箱
1717
18-
[**功能特性**](#-功能特性) · [**快速开始**](#-快速开始) · [**推送效果**](#-推送效果) · [**文档中心**](docs/INDEX.md) · [**完整指南**](docs/full-guide.md) · [**常见问题**](docs/FAQ.md) · [**更新日志**](docs/CHANGELOG.md)
18+
[**产品预览**](#-产品预览) · [**功能特性**](#-功能特性) · [**快速开始**](#-快速开始) · [**推送效果**](#-推送效果) · [**文档中心**](docs/INDEX.md) · [**完整指南**](docs/full-guide.md)
1919

2020
简体中文 | [English](docs/README_EN.md) | [繁體中文](docs/README_CHT.md)
2121

@@ -115,8 +115,8 @@
115115

116116
| Secret 名称 | 说明 | 必填 |
117117
|------------|------|:----:|
118-
| `ANSPIRE_API_KEYS` | [Anspire AI Search](https://aisearch.anspire.cn/):中文内容特别优化,适合 A 股新闻和舆情检索;同一 Key 可复用为 Anspire 大模型 | 推荐 |
119-
| `SERPAPI_API_KEYS` | [SerpAPI](https://serpapi.com/baidu-search-api?utm_source=github_daily_stock_analysis):搜索引擎结果补强,适合实时金融新闻 | 推荐 |
118+
| `ANSPIRE_API_KEYS` | [Anspire AI Search](https://aisearch.anspire.cn/):中文内容特别优化,适合 A 股新闻和舆情检索;同一 Key 可复用为 Anspire 大模型 | **推荐** |
119+
| `SERPAPI_API_KEYS` | [SerpAPI](https://serpapi.com/baidu-search-api?utm_source=github_daily_stock_analysis):搜索引擎结果补强,适合实时金融新闻 | **推荐** |
120120
| `TAVILY_API_KEYS` | [Tavily](https://tavily.com/):通用新闻搜索 API | 可选 |
121121
| `BOCHA_API_KEYS` | [博查搜索](https://open.bocha.cn/):中文搜索优化,支持 AI 摘要 | 可选 |
122122
| `BRAVE_API_KEYS` | [Brave Search](https://brave.com/search/api/):隐私优先,美股资讯补强 | 可选 |
@@ -241,12 +241,14 @@ python main.py --webui-only
241241

242242
> Agent 具体参数、`skill` 命名兼容、多 Agent 模式和预算护栏见 [完整指南](docs/full-guide.md#本地-webui-管理界面)[LLM 配置指南](docs/LLM_CONFIG_GUIDE.md)
243243
244-
## 相关项目 (Related Projects)
244+
## 🧩 相关项目 (Related Projects)
245245

246-
DSA 聚焦日常分析报告;下面两个同系列项目分别覆盖选股、策略验证与策略进化,适合按需延伸使用。它们当前独立维护,后续会优先探索与 DSA 的候选股导入、回测验证和报告联动。
246+
> DSA 聚焦日常分析报告;下面两个同系列项目分别覆盖选股、策略验证与策略进化,适合按需延伸使用。它们当前独立维护,后续会优先探索与 DSA 的候选股导入、回测验证和报告联动。
247247
248-
- [AlphaSift](https://github.com/ZhuLinsen/alphasift):多因子选股与全市场扫描,用于从股票池中提取候选标的。
249-
- [AlphaEvo](https://github.com/ZhuLinsen/alphaevo):策略回测与自我进化,用于验证策略规则,并通过迭代探索策略参数与组合。
248+
| 项目 | 定位 |
249+
|------|------|
250+
| [AlphaSift](https://github.com/ZhuLinsen/alphasift) | 多因子选股与全市场扫描,用于从股票池中提取候选标的 |
251+
| [AlphaEvo](https://github.com/ZhuLinsen/alphaevo) | 策略回测与自我进化,用于验证策略规则,并通过迭代探索策略参数与组合 |
250252

251253
## 📬 联系与合作
252254

@@ -255,7 +257,7 @@ DSA 聚焦日常分析报告;下面两个同系列项目分别覆盖选股、
255257
<td width="92" valign="top"><strong>合作邮箱</strong></td>
256258
<td valign="top">
257259
<a href="mailto:zhuls345@gmail.com">zhuls345@gmail.com</a><br>
258-
定制化开发、私有部署与二次开发
260+
项目咨询、部署支持与功能扩展
259261
</td>
260262
<td align="center" rowspan="3" valign="middle" width="148">
261263
<a href="http://xhslink.com/m/tU520DWCKT" target="_blank"><img src="./docs/assets/xiaohongshu_tick.jpg" width="112" alt="小红书二维码"></a><br>
@@ -276,20 +278,7 @@ DSA 聚焦日常分析报告;下面两个同系列项目分别覆盖选股、
276278

277279
[MIT License](LICENSE) © 2026 ZhuLinsen
278280

279-
如果你在项目中使用或基于本项目进行二次开发,
280-
非常欢迎在 README 或文档中注明来源并附上本仓库链接。
281-
这将有助于项目的持续维护和社区发展。
282-
283-
## ⭐ Star History
284-
**如果觉得有用,请给个 ⭐ Star 支持一下!**
285-
286-
<a href="https://star-history.com/#ZhuLinsen/daily_stock_analysis&Date">
287-
<picture>
288-
<source media="(prefers-color-scheme: dark)" srcset="https://api.star-history.com/svg?repos=ZhuLinsen/daily_stock_analysis&type=Date&theme=dark" />
289-
<source media="(prefers-color-scheme: light)" srcset="https://api.star-history.com/svg?repos=ZhuLinsen/daily_stock_analysis&type=Date" />
290-
<img alt="Star History Chart" src="https://api.star-history.com/svg?repos=ZhuLinsen/daily_stock_analysis&type=Date" />
291-
</picture>
292-
</a>
281+
欢迎在二次开发或引用时注明本仓库来源,感谢支持项目持续维护。
293282

294283
## ⚠️ 免责声明
295284

docs/CHANGELOG.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/).
1515
- [新功能] Web 系统设置页开放 `.env` 配置备份导入/导出,复用键级覆盖、配置版本冲突保护和重载链路;Web 端在 `ADMIN_AUTH_ENABLED=false` 时该入口为禁用状态。
1616
- [chore] 精简仓库根目录:将文档图片资源迁入 `docs/assets/`,将东方财富请求补丁迁入 `src/patches/`,并下移 CI 专用依赖文件与技能适配服务。
1717
- [文档] 更新多语言 README 首页浅色工作台 GIF,并精简功能特性表,保留原有赞助商、快速开始和推送效果结构。
18+
- [文档] 恢复多语言 README 新闻源配置表中推荐项的加粗样式,统一相关项目章节层级,并精简顶部导航、联系文案和尾部展示。
1819

1920
## [3.16.0] - 2026-05-10
2021

docs/README_CHT.md

Lines changed: 10 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@
1717

1818
每日自動分析自選股 -> 生成決策儀表盤 -> 推送到 Telegram / Discord / Slack / 郵件 / 企業微信 / 飛書。
1919

20-
[**功能特性**](#-功能特性) · [**快速開始**](#-快速開始) · [**推送效果**](#-推送效果) · [**文檔中心**](./INDEX.md) · [**完整指南**](./full-guide.md) · [**常見問題**](./FAQ.md) · [**更新日誌**](./CHANGELOG.md)
20+
[**產品預覽**](#-產品預覽) · [**功能特性**](#-功能特性) · [**快速開始**](#-快速開始) · [**推送效果**](#-推送效果) · [**文檔中心**](./INDEX.md) · [**完整指南**](./full-guide.md)
2121

2222
繁體中文 | [English](README_EN.md) | [简体中文](../README.md)
2323

@@ -116,8 +116,8 @@
116116

117117
| Secret 名稱 | 說明 | 必填 |
118118
|-------------|------|:----:|
119-
| `ANSPIRE_API_KEYS` | [Anspire AI Search](https://aisearch.anspire.cn/):中文內容特別優化,可增強 A 股分析效果;同一 Key 也可作為 Anspire 大模型網關兜底示例 | 推薦 |
120-
| `SERPAPI_API_KEYS` | [SerpAPI](https://serpapi.com/baidu-search-api?utm_source=github_daily_stock_analysis):搜尋引擎結果補強,適合即時金融新聞 | 推薦 |
119+
| `ANSPIRE_API_KEYS` | [Anspire AI Search](https://aisearch.anspire.cn/):中文內容特別優化,可增強 A 股分析效果;同一 Key 也可作為 Anspire 大模型網關兜底示例 | **推薦** |
120+
| `SERPAPI_API_KEYS` | [SerpAPI](https://serpapi.com/baidu-search-api?utm_source=github_daily_stock_analysis):搜尋引擎結果補強,適合即時金融新聞 | **推薦** |
121121
| `TAVILY_API_KEYS` | [Tavily](https://tavily.com/):通用新聞搜尋 API | 可選 |
122122
| `BOCHA_API_KEYS` | [博查搜尋](https://open.bocha.cn/):中文搜尋優化,支援 AI 摘要 | 可選 |
123123
| `BRAVE_API_KEYS` | [Brave Search](https://brave.com/search/api/):隱私優先,美股資訊補強 | 可選 |
@@ -229,12 +229,14 @@ python main.py --webui-only
229229

230230
> Agent 具體參數、`skill` 命名兼容、多 Agent 模式和預算護欄見 [完整指南](./full-guide.md#本地-webui-管理界面)[LLM 配置指南](./LLM_CONFIG_GUIDE.md)
231231
232-
## 相關項目 (Related Projects)
232+
## 🧩 相關項目 (Related Projects)
233233

234-
DSA 聚焦日常分析報告;以下兩個同系列項目分別覆蓋選股、策略驗證與策略進化,適合按需延伸使用。它們目前獨立維護,後續會優先探索與 DSA 的候選股導入、回測驗證和報告聯動。
234+
> DSA 聚焦日常分析報告;以下兩個同系列項目分別覆蓋選股、策略驗證與策略進化,適合按需延伸使用。它們目前獨立維護,後續會優先探索與 DSA 的候選股導入、回測驗證和報告聯動。
235235
236-
- [AlphaSift](https://github.com/ZhuLinsen/alphasift):多因子選股與全市場掃描,用於從股票池中整理候選標的。
237-
- [AlphaEvo](https://github.com/ZhuLinsen/alphaevo):策略回測與自我進化,用於驗證策略規則,並透過迭代探索策略參數與組合。
236+
| 項目 | 定位 |
237+
|------|------|
238+
| [AlphaSift](https://github.com/ZhuLinsen/alphasift) | 多因子選股與全市場掃描,用於從股票池中整理候選標的 |
239+
| [AlphaEvo](https://github.com/ZhuLinsen/alphaevo) | 策略回測與自我進化,用於驗證策略規則,並透過迭代探索策略參數與組合 |
238240

239241
## 📬 聯繫與合作
240242

@@ -243,7 +245,7 @@ DSA 聚焦日常分析報告;以下兩個同系列項目分別覆蓋選股、
243245
<td width="92" valign="top"><strong>合作郵箱</strong></td>
244246
<td valign="top">
245247
<a href="mailto:zhuls345@gmail.com">zhuls345@gmail.com</a><br>
246-
定制化開發、私有部署與二次開發
248+
項目諮詢、部署支援與功能擴展
247249
</td>
248250
<td align="center" rowspan="3" valign="middle" width="148">
249251
<a href="http://xhslink.com/m/tU520DWCKT" target="_blank"><img src="assets/xiaohongshu_tick.jpg" width="112" alt="小紅書二維碼"></a><br>
@@ -266,18 +268,6 @@ DSA 聚焦日常分析報告;以下兩個同系列項目分別覆蓋選股、
266268

267269
如果你在項目中使用或基於本項目進行二次開發,非常歡迎在 README 或文檔中註明來源並附上本倉庫鏈接。
268270

269-
## ⭐ Star History
270-
271-
**如果覺得有用,請給個 ⭐ Star 支持一下!**
272-
273-
<a href="https://star-history.com/#ZhuLinsen/daily_stock_analysis&Date">
274-
<picture>
275-
<source media="(prefers-color-scheme: dark)" srcset="https://api.star-history.com/svg?repos=ZhuLinsen/daily_stock_analysis&type=Date&theme=dark" />
276-
<source media="(prefers-color-scheme: light)" srcset="https://api.star-history.com/svg?repos=ZhuLinsen/daily_stock_analysis&type=Date" />
277-
<img alt="Star History Chart" src="https://api.star-history.com/svg?repos=ZhuLinsen/daily_stock_analysis&type=Date" />
278-
</picture>
279-
</a>
280-
281271
## ⚠️ 免責聲明
282272

283273
本項目僅供學習和研究使用,不構成任何投資建議。股市有風險,投資需謹慎。作者不對使用本項目產生的任何損失負責。

docs/README_EN.md

Lines changed: 10 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@
1717

1818
Analyze your watchlist daily -> generate a decision dashboard -> push to Telegram / Discord / Slack / Email / WeChat Work / Feishu.
1919

20-
[**Key Features**](#-key-features) · [**Quick Start**](#-quick-start) · [**Sample Output**](#-sample-output) · [**Documentation Index**](./INDEX_EN.md) · [**Full Guide**](./full-guide_EN.md) · [**FAQ**](./FAQ_EN.md) · [**Changelog**](./CHANGELOG.md)
20+
[**Product Preview**](#-product-preview) · [**Key Features**](#-key-features) · [**Quick Start**](#-quick-start) · [**Sample Output**](#-sample-output) · [**Documentation Index**](./INDEX_EN.md) · [**Full Guide**](./full-guide_EN.md)
2121

2222
English | [简体中文](../README.md) | [繁體中文](README_CHT.md)
2323

@@ -116,8 +116,8 @@ News search strongly improves sentiment, announcements, events, and catalyst qua
116116

117117
| Secret Name | Description | Required |
118118
|-------------|-------------|:--------:|
119-
| `ANSPIRE_API_KEYS` | [Anspire AI Search](https://aisearch.anspire.cn/), optimized for Chinese content and A-share analysis; the same key can also be used for Anspire LLM fallback examples | Recommended |
120-
| `SERPAPI_API_KEYS` | [SerpAPI](https://serpapi.com/baidu-search-api?utm_source=github_daily_stock_analysis), search-engine results for realtime financial news | Recommended |
119+
| `ANSPIRE_API_KEYS` | [Anspire AI Search](https://aisearch.anspire.cn/), optimized for Chinese content and A-share analysis; the same key can also be used for Anspire LLM fallback examples | **Recommended** |
120+
| `SERPAPI_API_KEYS` | [SerpAPI](https://serpapi.com/baidu-search-api?utm_source=github_daily_stock_analysis), search-engine results for realtime financial news | **Recommended** |
121121
| `TAVILY_API_KEYS` | [Tavily](https://tavily.com/), general news search API | Optional |
122122
| `BOCHA_API_KEYS` | [Bocha](https://open.bocha.cn/), Chinese search with AI summaries | Optional |
123123
| `BRAVE_API_KEYS` | [Brave Search](https://brave.com/search/api/), privacy-first search and US-stock news enrichment | Optional |
@@ -229,12 +229,14 @@ After configuring any available AI API key, the Web `/chat` page can use strateg
229229

230230
> Agent parameters, `skill` naming compatibility, multi-agent mode, and budget guards are covered in the [Full Guide](./full-guide_EN.md#local-webui-management-interface) and [LLM Config Guide](./LLM_CONFIG_GUIDE_EN.md).
231231
232-
## Related Projects
232+
## 🧩 Related Projects
233233

234-
DSA focuses on daily analysis reports. These sibling projects cover stock screening, strategy validation, and strategy evolution for users who want to extend the workflow. They are maintained independently today, with candidate import, backtest validation, and report handoff planned as future integration directions.
234+
> DSA focuses on daily analysis reports. These sibling projects cover stock screening, strategy validation, and strategy evolution for users who want to extend the workflow. They are maintained independently today, with candidate import, backtest validation, and report handoff planned as future integration directions.
235235
236-
- [AlphaSift](https://github.com/ZhuLinsen/alphasift): multi-factor stock screening and full-market scanning for building candidate watchlists.
237-
- [AlphaEvo](https://github.com/ZhuLinsen/alphaevo): strategy backtesting and self-evolution experiments for validating rules and iteratively exploring strategy parameters and combinations.
236+
| Project | Focus |
237+
|---------|-------|
238+
| [AlphaSift](https://github.com/ZhuLinsen/alphasift) | Multi-factor stock screening and full-market scanning for building candidate watchlists |
239+
| [AlphaEvo](https://github.com/ZhuLinsen/alphaevo) | Strategy backtesting and self-evolution experiments for validating rules and iteratively exploring strategy parameters and combinations |
238240

239241
## 📞 Contact
240242

@@ -243,7 +245,7 @@ DSA focuses on daily analysis reports. These sibling projects cover stock screen
243245
<td width="92" valign="top"><strong>Email</strong></td>
244246
<td valign="top">
245247
<a href="mailto:zhuls345@gmail.com">zhuls345@gmail.com</a><br>
246-
Custom development, private deployment, and integration work
248+
Project consulting, deployment support, and feature extensions
247249
</td>
248250
<td align="center" rowspan="3" valign="middle" width="148">
249251
<a href="http://xhslink.com/m/tU520DWCKT" target="_blank"><img src="assets/xiaohongshu_tick.jpg" width="112" alt="Xiaohongshu QR code"></a><br>
@@ -266,18 +268,6 @@ DSA focuses on daily analysis reports. These sibling projects cover stock screen
266268

267269
If you use or build on this project, attribution with a link back to this repository is appreciated.
268270

269-
## ⭐ Star History
270-
271-
**Star this repo if you find it useful.**
272-
273-
<a href="https://star-history.com/#ZhuLinsen/daily_stock_analysis&Date">
274-
<picture>
275-
<source media="(prefers-color-scheme: dark)" srcset="https://api.star-history.com/svg?repos=ZhuLinsen/daily_stock_analysis&type=Date&theme=dark" />
276-
<source media="(prefers-color-scheme: light)" srcset="https://api.star-history.com/svg?repos=ZhuLinsen/daily_stock_analysis&type=Date" />
277-
<img alt="Star History Chart" src="https://api.star-history.com/svg?repos=ZhuLinsen/daily_stock_analysis&type=Date" />
278-
</picture>
279-
</a>
280-
281271
## ⚠️ Disclaimer
282272

283273
This project is for informational and educational purposes only. AI-generated analysis is not investment advice. Stock market investing involves risk; do your own research and consult a licensed financial advisor when needed.

0 commit comments

Comments
 (0)