videos - fitizens/hugo-modules GitHub Wiki

Video Modules

Installation

Add the following code to your module list in the config/_default/module.toml file.

[imports](/fitizens/hugo-modules/wiki/imports)
path = "github.com/gethugothemes/hugo-modules/videos"

Local/Remote Video

Using Partial

<!-- minimal use -->
{{ partial "video.html" (dict "Src" "https://www.w3schools.com/html/mov_bbb.mp4") }}

<!-- extended use -->
{{ partial "video.html" (dict "Src" "videos/demo.mp4" "Width" "500" "Height" "auto" "Autoplay" "false" "Loop" "false" "Muted" "false" "Controls" "true" "Class" "ght-video") }}

Using Shortcode

<!-- minimal use -->
{{< video src="https://www.w3schools.com/html/mov_bbb.mp4" >}}

<!-- extended use -->
{{< video src="videos/demo.mp4" width="500" height="auto" autoplay="false" loop="false" muted="false" controls="true" class="" >}}

Available parameters/options:

  • src: video source
  • width: video width
  • height: video height
  • autoplay: autoplay video | default: "false"
  • loop: loop video after end | default: "false"
  • muted: play video without sound | default: "false"
  • controls: video controller | default: "true"
  • class: video class

YouTube Video (Lite and Fast)

To add Youtube video as a Partial or Shortcode, add this plugin to your config.toml file.

[params.plugins.js](/fitizens/hugo-modules/wiki/params.plugins.js)
link = "plugins/youtube-lite.js"

Using Partial

<!-- minimal use -->
{{ partial "youtube-lite.html" (dict "Id" "6FIoOJm3vYA") }}

<!-- extended use -->
{{ partial "youtube-lite.html" (dict "Id" "6FIoOJm3vYA" "Class" "mx-auto"  "Width" "600px" "Style" "" "Attr" "") }}

Using Shortcode

<!-- minimal use -->
{{< youtube-lite 6FIoOJm3vYA >}}

<!-- extended use -->
{{< youtube-lite id="6FIoOJm3vYA" class="mx-auto" width="600px" style="" attr="" >}}

Available parameters/options:

  • id: YouTube video Id (ex: youtube.com/watch?v=FeHiF0XQ8VQ)
  • class: video class
  • width: video width
  • style: add custom style
  • attr: add custom attribute

Vimeo Video (Lite and Fast)

To add Vimeo video as a Partial or Shortcode, add this plugin to your config.toml file.

[params.plugins.js](/fitizens/hugo-modules/wiki/params.plugins.js)
link = "plugins/vimeo-lite.js"

Using Partial

<!-- minimal use -->
{{ partial "vimeo-lite.html" (dict "Id" "805124764") }}

<!-- extended use -->
{{ partial "vimeo-lite.html" (dict "Id" "805124764" "Class" "mx-auto"  "Width" "600px" "Style" "" "Attr" "") }}

Using Shortcode

<!-- minimal use -->
{{< vimeo-lite 364402896 >}}

<!-- extended use -->
{{< vimeo-lite id="364402896" class="mx-auto" width="600px" style="" attr="" >}}

Available parameters/options:

  • id: YouTube video Id (ex: vimeo.com/805124764)
  • class: video class
  • width: video width
  • style: add custom style
  • attr: add custom attribute