jekyll-livid 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 0216c276b3b0843b9ce7a12d52d53a7989d52fbbd46dbd962b54ddece1f74cc9
+  data.tar.gz: 9e1936ee63036cf826132070cb131c89dc56ff8f7095ca5c812aeacd45e7d897
+SHA512:
+  metadata.gz: 6bd03db1a5d593d0bed26b524f4315a3d87113dbe650727625a883b2b007ffb8cdcdfb33557c4974aed67ef1dfa229117aa9778e9b6740a236d759f06aae0591
+  data.tar.gz: 8493a2dad67d78e96266e5f716dea5daae15164d1b0cc99b8489b5e6aaf7c934fafff8f2dc0bfd1bda666d698ea87260e51794919ca97ce75710073482cfd048

data/CHANGELOG.md

@@ -0,0 +1,9 @@
+# Changelog
+
+## 0.1.0
+
+- Initial release
+- `{% livid VIDEO_ID %}` tag with responsive 16:9 iframe wrapper
+- Full support for all Livid advanced embedding parameters
+- `#t=` hash fragment support for timestamp start
+- Unknown parameter warnings via Jekyll logger

data/CONTRIBUTING.md

@@ -0,0 +1,22 @@
+# Contributing
+
+Thanks for your interest in improving `jekyll-livid`.
+
+## Before submitting changes
+
+1. Keep the scope narrow and focused on Livid video embedding.
+2. Add or update tests for behavior changes.
+3. Run the test suite before opening a pull request.
+
+## Local development
+
+```bash
+bundle install
+ruby -Ilib -Itest test/livid_tag_test.rb
+```
+
+## Design philosophy
+
+- One tag, one job: embed Livid videos cleanly
+- All advanced parameters passed through to the iframe src
+- No dependencies beyond Jekyll itself

data/LICENSE.txt

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Jason Chance
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,141 @@
+# jekyll-livid
+
+A Jekyll plugin that provides a `{% livid %}` Liquid tag for embedding [Livid](https://livid.com)-hosted videos with a responsive iframe wrapper and full support for [advanced embedding parameters](https://support.livid.com/article/46-advanced-embedding-parameters).
+
+## Scope
+
+This plugin is intentionally narrow. It handles one thing: embedding Livid videos cleanly in Jekyll templates with a minimal, standards-compliant iframe output.
+
+## Who this is for
+
+- Jekyll site owners who host video on Livid
+- Anyone migrating from Vimeo to Livid who wants drop-in embed support
+- Developers who want fine-grained control over player behavior via URL parameters
+
+## Features
+
+- `{% livid VIDEO_ID %}` tag with responsive 16:9 iframe wrapper
+- Full support for all [Livid advanced embedding parameters](https://support.livid.com/article/46-advanced-embedding-parameters)
+- `#t=` hash fragment support for timestamp-based start positions
+- Unknown parameter warnings via Jekyll logger (skipped silently in output)
+- Lazy-loading iframe by default
+
+## GitHub Pages compatibility
+
+This plugin is compatible with Jekyll sites deployed to GitHub Pages **when the site is built through a custom GitHub Actions workflow**.
+
+It is **not** compatible with the default GitHub Pages safe-mode build, which does not load custom plugins.
+
+## Installation
+
+Published on RubyGems:
+
+- https://rubygems.org/gems/jekyll-livid
+
+Add the gem to your `Gemfile`:
+
+```ruby
+gem "jekyll-livid", "~> 0.1.0"
+```
+
+Then add it to `_config.yml`:
+
+```yml
+plugins:
+  - jekyll-livid
+```
+
+Run:
+
+```bash
+bundle install
+```
+
+## Styling
+
+The plugin outputs a wrapper `div` with the class `livid-embed`. No spacing or layout styles are applied — this is intentional, since every site has its own typographic rhythm and spacing scale.
+
+If the embed sits too close to the content below it, add a rule to your site's CSS or SCSS:
+
+```css
+.livid-embed {
+  margin-bottom: 32px; /* adjust to match your site's heading/paragraph spacing */
+}
+```
+
+## Usage
+
+### Basic embed
+
+```liquid
+{% livid CEm15HFpXlBO %}
+```
+
+### With parameters
+
+```liquid
+{% livid CEm15HFpXlBO autoplay=true muted=true loop=true %}
+{% livid CEm15HFpXlBO color=ff0000 controls=false %}
+{% livid CEm15HFpXlBO dnt=true %}
+{% livid CEm15HFpXlBO t=30 %}
+```
+
+The `t` parameter starts playback at a specific second and is appended as a URL hash fragment (`#t=30`). All other parameters are appended as query string parameters.
+
+## Advanced embedding parameters
+
+All parameters from the [Livid advanced embedding documentation](https://support.livid.com/article/46-advanced-embedding-parameters) are supported. Boolean parameters accept `true`/`false` or `1`/`0`.
+
+| Parameter | Values | Default | Notes |
+|-----------|--------|---------|-------|
+| `airplay` | true/false | true | AirPlay support (Safari only). Pro/Premium accounts. |
+| `autoplay` | true/false | false | Autostart playback. |
+| `background` | true/false | false | Background mode: no controls, loops, autoplay, muted. Pro/Premium. |
+| `cc` | true/false | true | Closed captions button. Pro/Premium. |
+| `chromecast` | true/false | true | Chromecast button. Pro/Premium. |
+| `color` | hex code | 4e48f9 | Player control color (no `#`). Pro/Premium. |
+| `colors` | 1–4 hex codes, comma-separated | — | Button, accent, icon/text, background. Pro/Premium. |
+| `controls` | true/false | true | Show/hide all player controls. Pro/Premium. |
+| `custom_logo` | true/false | — | Show custom logo. Pro/Premium. |
+| `dnt` | true/false | false | Do Not Track — disables analytics. All videos. |
+| `fullscreen` | true/false | true | Fullscreen button. Pro/Premium. |
+| `keyboard` | true/false | true | Keyboard controls. All videos. |
+| `livid_logo` | true/false | true | Show Livid logo. Pro/Premium. |
+| `loop` | true/false | false | Loop the video. All videos. |
+| `max_quality` | 240p–4k | auto | Maximum quality ceiling. Pro/Premium. |
+| `min_quality` | 240p–4k | auto | Minimum quality floor. Pro/Premium. |
+| `muted` | true/false | false | Mute on load. All videos. |
+| `pip` | true/false | true | Picture-in-picture button. Pro/Premium. |
+| `play_button_position` | auto/bottom/center | auto | Play button position. Pro/Premium. |
+| `playsinline` | true/false | true | Inline playback on mobile. All videos. |
+| `preload` | auto/metadata/none | none | Pre-playback loading behavior. All videos. |
+| `progress_bar` | true/false | true | Progress bar. Pro/Premium. |
+| `quality_selector` | true/false | true | Quality selector menu. Pro/Premium. |
+| `share` | true/false | true | Share button. Pro/Premium. |
+| `speed` | true/false | true | Speed controls. Pro/Premium. |
+| `t` | seconds | 0 | Start at timestamp (appended as `#t=N`). All videos. |
+| `title` | true/false | true | Show video title. Pro/Premium. |
+| `transparent` | true/false | true | Transparent iframe background. All videos. |
+| `volume` | true/false | true | Volume control. Pro/Premium. |
+
+## Live example
+
+- https://jasonchance.com/projects/jekyll-livid/
+
+## Development
+
+Install dependencies:
+
+```bash
+bundle install
+```
+
+Run tests:
+
+```bash
+ruby -Ilib -Itest test/livid_tag_test.rb
+```
+
+## License
+
+MIT

data/lib/jekyll/livid_tag.rb

@@ -0,0 +1,66 @@
+require "cgi"
+
+module Jekyll
+  class LividTag < Liquid::Tag
+    EMBED_BASE = "https://livid.com/embed/".freeze
+
+    # Parameters appended as URL hash fragments rather than query params
+    HASH_PARAMS = %w[t].freeze
+
+    # All supported advanced embed parameters
+    # https://support.livid.com/article/46-advanced-embedding-parameters
+    VALID_PARAMS = %w[
+      airplay autoplay background cc chromecast color colors controls
+      custom_logo dnt fullscreen keyboard livid_logo loop max_quality
+      min_quality muted pip play_button_position playsinline preload
+      progress_bar quality_selector share speed t title transparent volume
+    ].freeze
+
+    def initialize(tag_name, markup, tokens)
+      super
+      parts = markup.strip.split(/\s+/, 2)
+      @video_id = parts[0]
+      @params = parse_params(parts[1] || "")
+    end
+
+    def render(_context)
+      raise "Livid tag requires a video ID" if @video_id.nil? || @video_id.empty?
+
+      query_params = @params.reject { |k, _| HASH_PARAMS.include?(k) }
+      hash_params  = @params.select { |k, _| HASH_PARAMS.include?(k) }
+
+      src = EMBED_BASE + @video_id
+      src += "?" + query_params.map { |k, v| "#{k}=#{CGI.escape(v.to_s)}" }.join("&") unless query_params.empty?
+      src += "#t=#{hash_params['t']}" if hash_params['t']
+
+      <<~HTML.strip
+        <div class="livid-embed" style="position:relative;padding-bottom:56.25%;height:0;overflow:hidden;">
+          <iframe
+            src="#{src}"
+            frameborder="0"
+            allow="autoplay; fullscreen; picture-in-picture"
+            allowfullscreen
+            style="position:absolute;top:0;left:0;width:100%;height:100%;"
+            loading="lazy">
+          </iframe>
+        </div>
+      HTML
+    end
+
+    private
+
+    def parse_params(raw)
+      params = {}
+      raw.scan(/(\w+)=([^\s]+)/) do |key, value|
+        if VALID_PARAMS.include?(key)
+          params[key] = value
+        else
+          Jekyll.logger.warn "Livid tag:", "Unknown parameter '#{key}' — ignored"
+        end
+      end
+      params
+    end
+  end
+end
+
+Liquid::Template.register_tag("livid", Jekyll::LividTag)

data/lib/jekyll-livid.rb

@@ -0,0 +1,4 @@
+require "jekyll"
+require "liquid"
+
+require_relative "jekyll/livid_tag"

metadata

@@ -0,0 +1,65 @@
+--- !ruby/object:Gem::Specification
+name: jekyll-livid
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jason Chance
+bindir: bin
+cert_chain: []
+date: 2026-08-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: jekyll
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+description: A Jekyll plugin that provides a {% livid %} Liquid tag for embedding
+  Livid-hosted videos with full support for advanced embedding parameters.
+email:
+- jchance@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- CONTRIBUTING.md
+- LICENSE.txt
+- README.md
+- lib/jekyll-livid.rb
+- lib/jekyll/livid_tag.rb
+homepage: https://github.com/jchance/jekyll-livid
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/jchance/jekyll-livid
+  source_code_uri: https://github.com/jchance/jekyll-livid
+  changelog_uri: https://github.com/jchance/jekyll-livid/blob/main/CHANGELOG.md
+  bug_tracker_uri: https://github.com/jchance/jekyll-livid/issues
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.2
+specification_version: 4
+summary: Jekyll Liquid tag for embedding Livid videos
+test_files: []