https://github.com/rondevhub/rsswidget
A simple, customizable, and themeable RSS/Atom feed widget for your website.
https://github.com/rondevhub/rsswidget
rss rss-feed rss-reader rss-widget
Last synced: 9 months ago
JSON representation
A simple, customizable, and themeable RSS/Atom feed widget for your website.
- Host: GitHub
- URL: https://github.com/rondevhub/rsswidget
- Owner: RonDevHub
- License: mit
- Created: 2025-05-20T14:05:14.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2025-05-21T05:45:56.000Z (about 1 year ago)
- Last Synced: 2025-05-21T06:22:09.027Z (about 1 year ago)
- Topics: rss, rss-feed, rss-reader, rss-widget
- Language: JavaScript
- Homepage:
- Size: 19.5 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# RSS Feed Embed Widget
A simple, customizable, and themeable RSS/Atom feed widget for your website.
Ein einfaches, anpassbares und themefähiges RSS/Atom-Feed-Widget für deine Webseite.
---
## Features / Funktionen
- Supports RSS 2.0 and Atom feeds
Unterstützt RSS 2.0 und Atom-Feeds
- Multiple themes (light, dark, green, blue, red, github)
Mehrere Themes (light, dark, green, blue, red, github)
- Language support: English, German, Italian, French, Ukrainian
Sprachunterstützung: Englisch, Deutsch, Italienisch, Französisch, Ukrainisch
- Show/hide favicon, header, footer, scrollbar
Favicon, Header, Footer, Scrollbar ein-/ausblendbar
- Responsive and easy to integrate
Responsiv und einfach einzubinden
- "Powered by" footer with GitHub link
"Powered by"-Footer mit GitHub-Link
- Pulsing SVG loader and error messages
Pulsierender SVG-Loader und Fehlermeldungen
---
## Quick Start / Schnellstart
**1. Download or clone this repository.**
1. Lade dieses Repository herunter oder klone es.
**2. Include the files in your HTML:**
2. Binde die Dateien in dein HTML ein:
```html
```
**3. Initialize the widget:**
3. Initialisiere das Widget:
```js
RSSWidget.init({
target: "#rss-widget", // CSS selector for the widget container / CSS-Selektor für das Widget-Element
title: "My Feed", // Widget title / Widget-Titel
feedUrl: "https://example.com/feed.xml", // RSS/Atom feed URL / RSS/Atom Feed-URL
showFavicon: true, // Show favicon in header (true) or hide (false) / Favicon im Header anzeigen (true) oder ausblenden (false)
limit: 5, // Maximum number of feed items to display / Maximale Anzahl der Feed-Einträge
height: "500px", // Widget height / Widget-Höhe
width: "400px", // Widget width / Widget-Breite
scrollbar: false, // Show scrollbar (true) or hide (false) / Scrollbar anzeigen (true) oder ausblenden (false)
refreshMinutes: 10, // Refresh interval in minutes / Aktualisierungsintervall in Minuten
header: true, // Show header (true) or hide (false) / Header anzeigen (true) oder ausblenden (false)
footer: true, // Show footer (true) or hide (false) / Footer anzeigen (true) oder ausblenden (false)
lang: "en", // Language: "de", "en", "it", "fr", "uk" / Sprache: "de", "en", "it", "fr", "uk"
theme: "light", // Theme: "light", "dark", "green", "blue", "red", "github" / Theme: "light", "dark", "green", "blue", "red", "github"
});
```
**4. Use the included PHP proxy for CORS and feed parsing:**
4. Nutze das mitgelieferte PHP-Proxy-Skript für CORS und Feed-Parsing:
- Place `rss-proxy.php` on your server
Lege `rss-proxy.php` auf deinen Server
---
## Options / Optionen
| Option | Type | Default | Description (EN) | Beschreibung (DE) |
| -------------- | -------- | --------- | -------------------------------------------------- | -------------------------------------------------- |
| target | string | "#rss-widget" | CSS selector for widget container | CSS-Selektor für das Widget-Element |
| title | string | "" | Widget title | Widget-Titel |
| feedUrl | string | "" | RSS/Atom feed URL | RSS/Atom Feed-URL |
| showFavicon | boolean | true | Show favicon in header | Favicon im Header anzeigen |
| limit | number | 5 | Max. number of feed items | Maximale Anzahl der Feed-Einträge |
| height | string | "500px" | Widget height (e.g. "500px" or "100%") | Widget-Höhe (z.B. "500px" oder "100%") |
| width | string | "400px" | Widget width (e.g. "400px" or "100%") | Widget-Breite (z.B. "400px" oder "100%") |
| scrollbar | boolean | false | Show scrollbar (true) or hide (false) | Scrollbar anzeigen (true) oder ausblenden (false) |
| refreshMinutes | number | 10 | Refresh interval in minutes | Aktualisierungsintervall in Minuten |
| header | boolean | true | Show header (true) or hide (false) | Header anzeigen (true) oder ausblenden (false) |
| footer | boolean | true | Show footer (true) or hide (false) | Footer anzeigen (true) oder ausblenden (false) |
| lang | string | "en" | Language: "de", "en", "it", "fr", "uk" | Sprache: "de", "en", "it", "fr", "uk" |
| theme | string | "light" | Theme: "light", "dark", "green", "blue", "red", "github" | Theme: "light", "dark", "green", "blue", "red", "github" |
---
## License / Lizenz
MIT License
MIT-Lizenz
---
## Author / Autor
[RonDevHub](https://github.com/RonDevHub)
