An open API service indexing awesome lists of open source software.

https://github.com/heroheman/trmnl_advanced_rss

A sophisticated RSS feed display plugin for TRMNL e-ink devices that transforms your favorite RSS feeds into beautifully formatted, customizable layouts.
https://github.com/heroheman/trmnl_advanced_rss

e-ink feed-reader plugin rss rss-feed trmnl trmnl-plugin

Last synced: 25 days ago
JSON representation

A sophisticated RSS feed display plugin for TRMNL e-ink devices that transforms your favorite RSS feeds into beautifully formatted, customizable layouts.

Awesome Lists containing this project

README

          

# Advanced RSS Plugin for TRMNL Display

A sophisticated RSS feed display plugin for [TRMNL](https://usetrmnl.com) e-ink devices that transforms your favorite RSS feeds into beautifully formatted, customizable layouts. This plugin goes beyond basic RSS display by offering multiple layout options, thumbnail support, and granular control over content presentation.

## ✨ Key Features

- **6 Distinct Layout Modes**: From compact lists to elegant grids, choose the perfect layout for your content
- **Smart Image Handling**: Optional thumbnail display with intelligent fallbacks
- **Flexible Content Display**: Toggle descriptions, customize text clipping, and control information density
- **Screen-Optimized**: Layouts specifically designed for 800x480 e-ink displays
- **Responsive Design**: Adapts to different content types and feed structures
- **Easy Configuration**: Simple settings to match your personal preferences

**Version:** v0.3.0 | [**Recipe:**](https://usetrmnl.com/recipes/79118/) | **Changelog:** [View Updates](https://github.com/heroheman/trmnl_advanced_rss/blob/main/CHANGELOG.md)

### How to install

1. [Fork Recipe](https://usetrmnl.com/recipes/79118/install) to your TRMNL
2. Add your RSS Feed, adjust the settings, set the refresh rate to whatever suits you best.
3. Add it to your Playlist and Mashups

### How to update:
*Important*: As this plugin has custom fields, it can only be forked. This means that it does not automatically update itself when a new version is available, but must be forked again.

## 🏞️ Example Layouts and applied options

| Layout ||
|--------|--------|
| ![Layout: Grid 1, Show Images, Show Description](screenshots/full_grid_images.jpg)
**Grid:** Show Images, Show Description | ![Layout: Grid 2, Show Images, No Description](screenshots/full_grid-2_no-description.jpg)
**Grid 2:** Show Images, No Description |
| ![Layout: Grid 3, Show Images, No Description](screenshots/full_grid_3_no-description.jpg)
**Grid 3:** Show Images, No Description | ![Layout: Grid 4, Show Images, No Description](screenshots/full_grid_4_no-description.jpg)
**Grid 4:** Show Images, No Description |
| ![Layout: Grid, No Images, Show Description](screenshots/full_grid_no-images.jpg)
**Grid:** No Images, Show Description | ![Layout: Grid, No Images, No Description](screenshots/full_grid_no-images_no-description.jpg)
**Grid:** No Images, No Description |
| ![Layout: List, Show Images](screenshots/full_list_col_1.jpg)
**List:** Show Images | ![Layout: List, No Images](screenshots/full_list_no-images.jpg)
**List:** No Images |
| ![Layout: List 2 Columns, Show Images](screenshots/full_list_col_2.jpg)
**List:** Show Images | ![PixelPerfect On](screenshots/full_pixelperfect_on.jpg)
**PixelPerfect:** True | ![PixelPerfect Off](screenshots/full_pixelperfect_off.jpg)
**PixelPerfect:** false |

_Screenshots taken inside trmnlp and in *v0.3.0* - there might be changes_

## Local Development
- install [TRMNLP](https://github.com/usetrmnl/trmnlp)
- `trmmnlp serve` to start a local server

## Links

- https://usetrmnl.com/recipes
- https://usetrmnl.com/plugins
- https://usetrmnl.com/integrations

### Docs
- https://docs.usetrmnl.com/go/private-plugins/templates
- https://docs.usetrmnl.com/go/private-plugins/templates-advanced
- https://docs.usetrmnl.com/go/private-plugins/create-a-screen
- https://docs.usetrmnl.com/go/reusing-markup

#### Design Framework
- https://usetrmnl.com/framework
- https://github.com/usetrmnl/trmnlp

#### Template Language:
- https://shopify.github.io/liquid/
- https://help.usetrmnl.com/en/articles/10347358-custom-plugin-filters

#### Javascript
- https://help.usetrmnl.com/en/articles/10693981-advanced-liquid