Skip to content

jessp01/jekyll-react-player

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

16 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Jekyll::ReactPlayer

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

Provides a Liquid tag for embedding all formats supported by react-player in Jekyll sites.

Installation

Add this line to your application's Gemfile:

gem 'jekyll-react-player'

And then execute:

$ bundle

Or install it yourself with:

$ gem install jekyll-react-player

Usage

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

{% reactplayer https://example.com/asset %}

This will render the below code:

<div id="#{id}">
<script src='https://cdn.rawgit.com/CookPete/react-player/master/dist/ReactPlayer.standalone.js'></script>
<script>
  const container = document.getElementById("#{id}")
  const url = '#{url}'
  renderReactPlayer(container, { url, playing: true, controls: true, width: '100%', height: '100%' })
</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.