产品简介
rss-to-readme 这是一个 GitHub Action，可自动从 RSS 订阅源获取最新内容并更新到 README 文件中，适合在 GitHub 项目中动态展示博客文章、更新日志等内容的开发者和维护者。
核心功能
- 从指定 RSS feed URL 获取内容
- 更新 README 的特定部分，通过 HTML 注释标记
- 可配置显示的最大条目数
- 支持自定义 Mustache 模板渲染条目
- 可设置是否在无变化时提交空提交
快速开始
- 在仓库的 .github/workflows 目录下创建 workflow 文件
- 配置 action 的 feed-url 和 readme-section 选项
- 在 README 中添加 HTML 注释标记更新部分
界面预览
与其他方案对比
| 对比项 | rss-to-readme | 同类方案 |
|---|---|---|
| 集成方式 | 作为 GitHub Action，无缝集成到工作流 | 可能需要手动编写脚本或使用外部服务 |
| 配置灵活性 | 支持自定义模板、最大条目数等多个选项 | 功能可能固定或需要更多自定义代码 |
适合谁用
- 需要在 README 中展示博客更新的个人开发者
- 希望自动化文档维护的开源项目团队
- 定期更新项目动态的 GitHub 用户
下载与版本
当前最新版本为 v2.0.0，发布于 2021-09-03。支持 Windows、macOS、Linux。
⚠️ 注意：本项目仅提供源代码下载，不包含可直接运行的安装包（exe/dmg/apk 等。下载后需要自行编译构建才能使用，适合有一定开发经验的用户。如果你不熟悉编译流程，建议寻找同类开箱即用的替代方案。
注意事项
- 本工具仅供学习和研究使用，请遵守相关法律法规。
- 请尊重内容创作者版权，勿将下载内容用于商业或非法传播。
- 项目源码地址：https://github.com/JasonEtco/rss-to-readme