RSSPAPER/README.md

1.8 KiB

RSSpaper logo

👉 DEMO 👈 (My own feed generated daily with Github Actions)

demo preview

Generate a static page with the latest news from your favorite feeds. Is it an RSS client? Yes, except that it generates an HTML/PWA that you can read or install on your tablet or mobile and to update the news you must run it again.

Run

  1. Create a file config.yaml with the following content. You can also use config.yaml.example as a base config and change it to fit your needs.
# Change the title, it's for you. Maybe you see "My newspaper"?
title: RSSPAPER

# Options: light or dark
theme: light

# Options: daily, weekly or all
edition: weekly

feeds:
  - https://programadorwebvalencia.com/feed/
  - https://republicaweb.es/feed/
  1. Download the latest version of RSSpaper (rsspaper-{version}-standalone.jar).

https://github.com/tanrax/RSSPAPER/releases

(Both jar and config.yaml must be in the same directory)

  1. Now you can execute.
java -jar rsspaper-{version}-standalone.jar

Great 🎉. You already have your 📰 own Static RSS Newspaper 📰.

That's it, now you just have to open dist/index.html.

Donation target

  • 50+ euros: Dark Theme.
  • 100+ euros: RSS feed generation to be read by other clients.
  • 150+ euros: Integrated web server and auto-compilation.
  • 200+ euros: Documentation for creating new templates and custom themes.

Buy Me a Coffee at ko-fi.com