0.0
The project is in a healthy, maintained state
Provides a Liquid tag for embedding trecs supported formats in Jekyll sites.
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
 Dependencies

Development

~> 2.2
~> 0
~> 13.0
~> 3.0
~> 1.0

Runtime

>= 2.0
 Project Readme

Jekyll::Trecs

.github/workflows/gem-build.yml Gem Version Gem License

Provides a Liquid tag for embedding trecs in Jekyll sites.

Installation

Add this line to your application's Gemfile:

gem 'jekyll-trecs'

And then execute:

$ bundle

Or install it yourself with:

$ gem install jekyll-trecs

Usage

Use the tag as follows in your Jekyll pages and posts:

{% trecs https://trecs.run/watch/id %}

This will render the below code:

<div style="max-width:900px; height:520px; margin:24px auto;">
  <!-- Add the bare attribute `autoplay` to start playback on load (with
       audio it starts muted and points at the unmute button). -->
  <trecs-player
    recording-id="#{id}"
    api-base="#{server_url}">
  </trecs-player>
</div>
<script src="#{server_url}/trecs-player.js"></script>

Development

After cloning the repo, run bin/setup to install dependencies. Then, 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 to create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.

Contributing

Contributions are, of course, welcome. Please submit a pull request.

License

Code is under AGPLv3 License.