quocvu / hexo-tag-youtube-responsive

Hexo tag plugin to embed a Youtube video that auto resizes with your responsive layout
MIT License
20 stars 3 forks source link

Build Status Coverage StatusNPM Downloads NPM Version Dependencies License

hexo-tag-youtube-responsive

Hexo tag plugin to embed a Youtube player that auto resizes with your responsive layout.

Install

Install using npm.

$ npm install hexo-tag-youtube-responsive --save

Usage

Embed a video

  {% youtuber video VIDEO_ID %}
  {% endyoutuber %}

For example

  {% youtuber video I07XMi7MHd4 %}
  {% endyoutuber %}

Embed a playlist

  {% youtuber playlist PLAYLIST_ID %}
  {% endyoutuber %}

For example

  {% youtuber playlist PLC77007E23FF423C6 %}
  {% endyoutuber %}

Note that you need to prepend the playlist ID with the letters PL as shown above

Embed search results of a query

  {% youtuber search QUERY_KEYWORDS %}
  {% endyoutuber %}

For example

  {% youtuber search hexo %}
  {% endyoutuber %}

  {% youtuber search hexo+tag+plugin %}
  {% endyoutuber %}

If your search has more than one keyword, use + to concatenate them together as shown above

Embed a user's uploaded videos (a.k.a. channel)

  {% youtuber user USERNAME %}
  {% endyoutuber %}

For example

  {% youtuber user daddybear %}
  {% endyoutuber %}

Note that you must supply the user name and not the channel ID

Parameters

You may specify additional parameters in YAML format as

{% youtuber video VIDEO_ID %}
  allowfullscreen: yes,
  autoplay: 1,
  cc_lang_pref: fr,
  cc_load_policy: 1,
  color: white,
  controls: 0,
  disablekb: 1,
  enablejsapi: 1,
  end: 210,
  frameborder: 20,
  fs: 0,
  height: 480,
  hl: fr,
  iv_load_policy: 3,
  loop: 1,
  modestbranding: 1,
  origin: your-domain,
  playlist: "videoId1,videoId2,videoId3",
  playsinline: 0,
  privacy_mode: yes,
  rel: 1,
  showinfo: 0,
  start: 30,
  widget_referrer: https://your-domain.com/some-page,
  width: 640,
{% endyoutuber %}

The majority of the parameters can be found in Youtube documentation.

For the remaining:

Defaults

The parameters above can be specified globally with default values via _config.yml file.

youtuber:
  allowfullscreen: yes,
  autoplay: 1