TRMNL::Liquid

A set of Liquid filters and tags used to render custom plugins for TRMNL.

Installation

Install the gem and add to the application's Gemfile by executing:

bundle add trmnl-liquid

If bundler is not being used to manage dependencies, install the gem by executing:

gem install trmnl-liquid

Usage

This gem registers global filters and tags for use in Liquid templates.

See lib/trmnl/liquid/filters.rb for the currently-supported filters.

Additionally, the {% template %} tag defines reusable chunks of markup:

{% template say_hello %}
<h1>Why hello there, {{ name }}!</h1>
{% endtemplate %}

{% render "say_hello", name: "General Kenobi" %}

Instead of Liquid::Template, simply use the TRMNL::Liquid::Template class for this enhanced functionality:

require 'trmnl-liquid'

markup = "Hello {{ count | number_with_delimiter }} people!"
template = TRMNL::Liquid::Template.parse(markup)
rendered = template.render(count: 1337)
# => "Hello 1,337 people!"

Internationalization (Optional)

Some filter functions (e.g. number_to_currency, l_word, and l_date) require translations provided by the rails-i18n and trmnl-i18n gems.

These dependencies are optional, and if missing will fall back to default behavior. If you want to internationalize, also include these gems:

# optional peer dependencies
gem "rails-i18n", "~> 8.0"
gem "trmnl-i18n", github: "usetrmnl/trmnl-i18n", branch: "main" # recommended for the latest changes

Development

After checking out the repo, run bin/setup to install dependencies. You can also run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and the created tag, and push the .gem file to rubygems.org.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/usetrmnl/trmnl-liquid.

License

The gem is available as open source under the terms of the MIT License.