Giter Site home page Giter Site logo

cay-zhang / rssbud Goto Github PK

View Code? Open in Web Editor NEW
1.2K 36.0 35.0 36.25 MB

An RSS feed discovery app for iOS/macOS that works particularly well with RSSHub, a popular feed generation service. Available on the App Store.

License: MIT License

Swift 36.86% JavaScript 63.14%
rsshub rss ios swiftui rsshub-radar rssbud rss-generator

rssbud's Introduction

RSSBud

中文文档

RSSBud can help you quickly discover and subscribe to RSS feeds from websites or apps, especially those provided by RSSHub. It supports the parameters feature of RSSHub which facilitates extra functionalities such as filtering by feed content and full text fetching.

Telegram Group

Demo.mp4

Download

Download on the App Store

Features

  • Detects RSS feeds in web pages
  • Detects RSSHub feeds applicable for web pages (supports almost all rules of RSSHub Radar)
  • Detects other RSS feeds applicable for web pages (powered by RSSBud Rules)
  • Optimized for mobile environment (automatically expands URLs and adapts to common mobile sub-domains)
  • Share sheet extension
  • Quick subscription to Reeder, Fiery Feeds, Ego Reader, and system default RSS reader
  • Quick subscription to Tiny Tiny RSS, Miniflux, Fresh RSS, Feedly, Inoreader, Feedbin, The Old Reader, Feeds Pub
  • Parameter editor for RSSHub feeds
  • Rules kept up-to-date automatically
  • Customizable remote rules files
  • Simultaneously matches against multiple rules files
  • RSSHub access control (automatically generates MD5 access code)
  • Supports x-callback-url; can be used in "Shortcuts" app to facilitate a variety of powerful functions (see Shortcut Workshop and Scheme)

Shortcut Workshop

If RSSBud doesn't support your RSS reader/service, or you want to integrate RSSBud into your workflow, you can write shortcuts utilizing RSSBud's support for x-callback-url to fulfill your needs. Let's start with the following ones!

RSSBud Starter Shortcut by cayZ | A template for RSSBud related shortcuts that sets up the variables and supports share sheets.

Analyze with RSSBud and Send with Telegram by cayZ | Send RSSBud analysis results to Telegram with customizable message template and recipient.

Analyze with RSSBud and Subscribe with Pocket Casts by cayZ | Send RSSBud analysis results to Pocket Casts (podcast RSS only).

Scan QR and Analyze with RSSBud by cayZ | Get URL from scanned QR code and analyze with RSSBud.

If you think you've got an idea of a shortcut that can benefit a larger audience, you're welcomed to submit an issue!

X-callback-url Scheme

RSSBud has implemented the x-callback-url protocol, which provides a standardized means for iOS developers to expose and document the methods they make available to other apps via custom URL schemes.

You can open the following URL to let RSSBud analyze the provided URL and return the RSS feed chosen by the user:

rssbud://x-callback-url/analyze?url[&x-callback-parameters...]

Parameters

  • url The URL you want RSSBud to analyze

x-success

  • feed_title The name of the RSS feed chosen by the user
  • feed_url The URL of the RSS feed chosen by the user

PopClip Extension

If you happen use both RSSBud and PopClip on macOS, here's a handy extension that can be used to analyze selected URLs with RSSBud. Simply select everything in the code block below and you will see an option to install the extension in PopClip.

#popclip
name: RSSBud
icon: iconify:ph:rss-bold
url: rssbud:///analyze?url=***

Notes for Building from Source

The core functionality of RSSBud comes from RSSBud Core, a sub-project written in JavaScript. The code is mainly referenced from RSSHub Radar.

Make sure you have Node.js installed before you build with Xcode.

If you wish to use the action extension, please set up your own App Group in both the iOS and Action Extension targets and modify RSSBud.appGroupIdentifier accordingly.

Rules

RSSBud’s functionality is largely powered by rules from two open-source projects. Please consider contributing to the appropriate rules if a particular feed can’t be discovered by RSSBud.

  • RSSHub Radar Rules are created and maintained by the RSSHub community. They are used to discover RSSHub feeds.

    Submit new RSSHub Radar rules

  • RSSBud Rules are a superset of RSSHub Radar rules. The extended schema allows non-RSSHub feeds (e.g. official RSS feeds that are not discoverable by parsing HTML) to be discovered. Please consider contributing to RSSHub Radar rules first if the feed is an RSSHub feed.

    Submit new RSSBud rules

Similar projects

Author

RSSBud is made by cayZ and is open-source under the MIT License.

rssbud's People

Contributors

cay-zhang avatar github-actions[bot] avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

rssbud's Issues

"Submit new rules" link is corrupted

在主页面上,Submit New Rules的链接指向了https://docs.rsshub.app/joinus/#ti-jiao-xin-de-rsshub-radar-gui-ze,本应是https://docs.rsshub.app/joinus/quick-start.html#ti-jiao-xin-de-rsshub-radar-gui-ze
问题似乎出在 Here

macOS 无法编译

目前的配置,在 target 为 Mac 时会失败,因为没有隐式导入 UIKit 框架。


Platform: DTK
macOS: 11.0 Beta (20A5343i)
Xcode: 12.0 beta 4 (12A8179i)

阿里云盘分享链接导入RSSBud后会在后面带上%3F(即“?”)导致导入失败

读取链接正常,但是从RSSHub源添加订阅到rss阅读软件时需要在rss阅读软件中手动删除链接后面的“%3F”(即URL Encode之后的“?”)

例如阿里云分享链接:https://www.aliyundrive.com/s/u5xCrzpMY1z/folder/63203ef3a4931f1a4b6c4820a05be309fcc9a592
导入RSSHub之后得到的rss订阅:http://xx.xx.xx.xx:xx/aliyundrive/files/u5xCrzpMY1z/63203ef3a4931f1a4b6c4820a05be309fcc9a592%3F

NetNewsWire 支持

这是一款很棒的免费rss阅读器,如果能做一键订阅就太好了。

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.