jekyll-mux
Mux, Video for Developers. jekyll-mux lets you embed a Mux-hosted video in Jekyll with one tag.
Open Source Plugin ∙

jekyll-mux

A Jekyll plugin that adds a {% mux %} Liquid tag for embedding Mux-hosted videos in a responsive iframe.

jekyll-mux is a Jekyll plugin that lets you embed a Mux-hosted video with one tag. It outputs a clean, responsive iframe wrapper that uses the official Mux Player embed URL.

Demo

{% mux 61zK4LlhV9P00tpGpsH7Fc00T58eR7m63b accent-color=#0066ff metadata-video-title="jekyll-mux demo" %}

Why This Exists

Mux is best-in-class video infrastructure. If you use Mux for video and Jekyll for your site, you shouldn’t have to write raw iframe HTML every time you want to embed a video. This plugin gives you a Liquid tag that builds the wrapper and passes along any Mux Player embed parameters.

Source Code

Installation

Add to your Gemfile:

gem "jekyll-mux", "~> 0.1"

Add to _config.yml:

plugins:
  - jekyll-mux

Then run bundle install.

Usage

Basic embed:

{% mux YOUR_PLAYBACK_ID %}

With parameters:

{% mux YOUR_PLAYBACK_ID accent-color=#ff0000 autoplay=false loop=false %}
{% mux YOUR_PLAYBACK_ID metadata-video-title="My Video" metadata-viewer-user-id=user-123 %}

Your playback ID is the string of letters and numbers in your Mux dashboard. It’s also the part after https://player.mux.com/ in an embed URL.

Supported Parameters

Parameter Description
accent-color Player accent color (CSS color value)
autoplay Autoplay on load
loop Loop playback
muted Start muted
playsinline Inline playback on mobile
preload auto, metadata, or none
stream-type on-demand or live
start-time Start position in seconds
metadata-video-title Video title for Mux Data analytics
metadata-video-id Custom video ID for Mux Data
metadata-viewer-user-id Viewer ID for Mux Data
metadata-player-name Player name for Mux Data

Styling

The plugin wraps the player in a div with the class mux-embed and doesn’t add any spacing. Add your own in your site CSS:

.mux-embed {
  margin-bottom: 2rem;
}