Skip to content

tkilaker/trmnl-recipes

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

18 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

TRMNL Recipes

A collection of custom TRMNL recipes (plugins) for e-ink displays. These recipes extend your TRMNL display with additional content sources, layouts, and functionality.

What is This Repository?

This repository contains ready-to-use TRMNL recipes that you can deploy to your own TRMNL display. Each recipe is a self-contained plugin that:

  • Fetches data from external sources (RSS feeds, APIs, etc.)
  • Formats content using Liquid templates
  • Renders optimized layouts for e-ink displays
  • Updates automatically based on configurable refresh intervals

Most recipes in this collection focus on Swedish content sources, but the structure and patterns can be adapted for other regions and use cases.

Available Recipes

✅ DN News

Display the latest Swedish news from Dagens Nyheter (DN) with article descriptions, elapsed time indicators, and official branding.

📦 Published Recipe - Install from TRMNL | View Recipe Details

✅ Sydsvenskan News

Display the latest Swedish news from Sydsvenskan newspaper with article descriptions, elapsed time indicators, and official branding.

📦 Published Recipe - Install from TRMNL | View Recipe Details

✅ Swedish Text-TV

Display classic SVT Text-TV (teletext) pages in authentic monospace styling with configurable page numbers and subpage support.

→ View Recipe Details

How to Use

Quick Install (Published Recipes)

Some recipes are published on TRMNL and can be installed with one click:

  • DN News and Sydsvenskan News are available as published recipes
  • Click the "Install from TRMNL" link above to add them directly to your display
  • You can fork these recipes to customize them for your needs

Local Development & Custom Recipes

Each recipe has its own README with detailed information about features, configuration options, and installation instructions. Browse the recipes above and follow the individual recipe documentation for local development and customization.

Getting Started

Prerequisites

Required:

Optional (for PNG rendering):

  • Firefox
  • ImageMagick

Once Ruby is installed, install the TRMNL local development server:

# Install trmnl_preview (provides the trmnlp command)
gem install trmnl_preview

Local Development

  1. Clone this repository:
git clone https://github.com/yourusername/trmnl-recipes.git
cd trmnl-recipes
  1. Navigate to a recipe directory:
cd sydsvenskan-news
# or
cd swedish-texttv
  1. Start the development server:
trmnlp serve
  1. Open your browser to view the recipe at the provided local URL

Publishing to TRMNL

  1. Ensure you're in a recipe directory
  2. Push to TRMNL:
trmnlp push
  1. Follow the prompts to authenticate and publish your recipe

Recipe Structure

Each recipe follows this structure:

recipe-name/
├── README.md              # Recipe documentation
├── icon.png              # Plugin icon (512x512px)
├── .trmnlp.yml           # Local development config
└── src/
    ├── settings.yml      # Plugin configuration
    └── *.liquid          # Layout templates (full, half_vertical, etc.)

Resources

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

License

MIT License - see LICENSE file for details

About

No description or website provided.

Topics

Resources

License

Stars

Watchers

Forks

Contributors

Languages