Skip to content

Instantly share code, notes, and snippets.

Embed
What would you like to do?
Jekyll YouTube Embed Plugin

This is a plugin meant for Jekyll.

Example use:

Easily embed a YouTube video. Just drop this file in your _plugins directory.

{% youtube oHg5SJYRHA0 %}

You can also specify a height and width. If you do not, it defaults to 560 x 420.

{% youtube oHg5SJYRHA0 500 400 %}
class YouTube < Liquid::Tag
Syntax = /^\s*([^\s]+)(\s+(\d+)\s+(\d+)\s*)?/
def initialize(tagName, markup, tokens)
super
if markup =~ Syntax then
@id = $1
if $2.nil? then
@width = 560
@height = 420
else
@width = $2.to_i
@height = $3.to_i
end
else
raise "No YouTube ID provided in the \"youtube\" tag"
end
end
def render(context)
# "<iframe width=\"#{@width}\" height=\"#{@height}\" src=\"http://www.youtube.com/embed/#{@id}\" frameborder=\"0\"allowfullscreen></iframe>"
"<iframe width=\"#{@width}\" height=\"#{@height}\" src=\"http://www.youtube.com/embed/#{@id}?color=white&theme=light\"></iframe>"
end
Liquid::Template.register_tag "youtube", self
end
@patrickfuller
Copy link

patrickfuller commented Jan 12, 2014

I had to make two minor edits for this to work.

Line 2:

- Syntax = /^\s*([^\s]+)(\s+(\d+)\s+(\d+)\s*)?/
+ Syntax = /^\s*([^\s]+)(?:\s+(\d+)\s+(\d+)\s*)?/

and line 24:

- "<iframe width=\"#{@width}\" height=\"#{@height}\" src=\"http://www.youtube.com/embed/#{@id}?color=white&theme=light\"></iframe>"
+ "<iframe width=\"#{@width}\" height=\"#{@height}\" src=\"http://www.youtube.com/embed/#{@id}?color=white&amp;theme=light\">&nbsp;</iframe>"

The first edit ensures that the match groups line up for optional width + height args, and the second escapes the ampersand and adds whitespace to the iframe to prevent text below the video being cut off (ref).

Anyway, thanks for posting this gist!

@tuananh
Copy link

tuananh commented Aug 14, 2014

A bit more pagespeed-friendly https://github.com/tuananh/BetterTube

@prdk0
Copy link

prdk0 commented Aug 6, 2015

hi i got an error from github "youtube is not recognize as a liquid tag" , please help on this .

@alejandrobabio
Copy link

alejandrobabio commented Aug 13, 2015

Hi @pradeekyahvi. I got the same issue, it's because github pages only support some plugins. I fix my issue with coffeescript. It's all at this commit.

Edit:
This is true if you are trying to make work this plugin with Github Pages. At your local computer, just put the source at _plugins directory.

@Jcrash29
Copy link

Jcrash29 commented Feb 11, 2016

Don't forget to add the following lines above the other script call:

<!-- jQuery (necessary for Bootstrap's JavaScript plugins) -->
<script src="https://ajax.googleapis.com/ajax/libs/jquery/1.11.3/jquery.min.js"></script>
<!-- Latest compiled and minified JavaScript -->
<script src="https://cdnjs.cloudflare.com/ajax/libs/jQuery.mmenu/5.3.4/js/jquery.mmenu.min.all.js"></script>

See my commit base on alejandrobabio's: Here

@guodidi
Copy link

guodidi commented Mar 27, 2016

Hello , i try to use the plugins in Jekyll , and i found it has some mistake. The Tag of also has the same height and width because of the Syntax has a mistake. i use the wiebsite a Ruby regular expression editor to test.

If i use your Syntax that is ^\s_([^\s]+)(\s+(\d+)\s+(\d+)\s_)? , and input YouTube_id 400 800 ,the editor will show me 4 variable ( second variable and third variable is similar) . so i think maybe your Syntax but not quick right. i try to modify the Syntax that is^\s_([^\s]+)\s_(\d+)?\s_(\d+)?\s_? and it can work.

so if possible , i hope you can check the Syntax again. Because your plugins is recommand in Jekll Plugins , maybe other people will found the same problem with me .

and thank you again.

@ltdinh
Copy link

ltdinh commented Jun 4, 2016

@avclark.
Now It's 2016. I'm new in Jekyll. but I want to answer for @avclark.
If you want to use this: {% youtube{{ post.video }} %}. You only write: {% youtube post.video %}.
And override code above:

class YouTube < Liquid::Tag
  Syntax = /^\s*([^\s]+)(\s+(\d+)\s+(\d+)\s*)?/

  def initialize(tagName, markup, tokens)
    super
    @content = markup
    if markup =~ Syntax then
      @id = $1

      if $2.nil? then
          @width = 560
          @height = 420
      else
          @width = $2.to_i
          @height = $3.to_i
      end
    else
      raise "No YouTube ID provided in the \"youtube\" tag"
    end
  end

  def render(context)
  @id = "#{context[@content.strip]}"
    # "<iframe width=\"#{@width}\" height=\"#{@height}\" src=\"http://www.youtube.com/embed/#{@id}\" frameborder=\"0\"allowfullscreen></iframe>"
    "<iframe width=\"#{@width}\" height=\"#{@height}\" src=\"http://www.youtube.com/embed/#{@id}?color=white&theme=light\"></iframe>"
  end

  Liquid::Template.register_tag "youtube", self
end

As you see. I have added new row: They are @content = markup and @id = "#{context[@content.strip]}"
I have tried and It works well :)

But If you want to use: {% youtube post.video 500 600 %}. You must change something: you can try as this:

Syntax = /^\s_([^\s]+)(\s+(\d+)\s+(\d+)\s_)?/

def initialize(tagName, markup, tokens)
super
if markup =~ Syntax then
@url_id = $1

  if $2.nil? then
      @width = 560
      @height = 420
  else
      @width = $2.to_i
      @height = $4.to_i
  end
else
  raise "No YouTube ID provided in the \"youtube\" tag"
end

end

def render(context)
@id = "#{context[@url_id.strip]}"
"<iframe width="#{@width}" height="#{@height}" src="http://www.youtube.com/embed/#{@id}?color=white&theme=light\"></iframe>"
end

Liquid::Template.register_tag "youtube", self
end

@IgniparousTempest
Copy link

IgniparousTempest commented Feb 12, 2018

I looked to see to see what the video link in the README.md pointed to... I was not disappointed. Well played, sir.

@dqvist
Copy link

dqvist commented Feb 6, 2019

It should be https src for the generated iframe code.
E.g.:
"<iframe width="#{@width}" height="#{@height}" src="https://www.youtube.com/embed/#{@id}?color=white&theme=light\"></iframe>"

@jeffreytse
Copy link

jeffreytse commented May 7, 2020

jekyll-spaceship - 🚀 A Jekyll plugin to provide powerful supports for table, mathjax, plantuml, mermail, emoji, youtube, vimeo, dailymotion, etc.

Github: https://github.com/jeffreytse/jekyll-spaceship

jekyll-spaceship-demo

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment