YouTube shortcode

Embed a YouTube video in your content using the youtube shortcode.

To override Hugo’s embedded youtube shortcode, copy the source code to a file with the same name in the layouts/_shortcodes directory.

Example

To display a YouTube video with this URL:

https://www.youtube.com/watch?v=0RKpf3rK57I

Include this in your Markdown:

{{< youtube 0RKpf3rK57I >}}

Hugo renders this to:

id: (string) The video id. Optional if the id is the first and only positional argument.
allowFullScreen: New in v0.125.0; (bool) Whether the iframe element can activate full screen mode. Default is true.
autoplay: New in v0.125.0; (bool) Whether to automatically play the video. Forces mute to true. Default is false.
class: (string) The class attribute of the wrapping div element. When specified, removes the style attributes from the iframe element and its wrapping div element.
controls: New in v0.125.0; (bool) Whether to display the video controls. Default is true.
end: New in v0.125.0; (int) The time, measured in seconds from the start of the video, when the player should stop playing the video.
loading: New in v0.125.0; (string) The loading attribute of the iframe element, either eager or lazy. Default is eager.
loop: New in v0.125.0; (bool) Whether to indefinitely repeat the video. Ignores the start and end arguments after the first play. Default is false.
mute: New in v0.125.0; (bool) Whether to mute the video. Always true when autoplay is true. Default is false.
start: New in v0.125.0; (int) The time, measured in seconds from the start of the video, when the player should start playing the video.
title: (string) The title attribute of the iframe element. Defaults to “YouTube video”.

Here’s an example using some of the available arguments:

{{< youtube id=0RKpf3rK57I start=30 end=60 loading=lazy >}}

Adjust the relevant privacy settings in your site configuration.

privacy:
  youTube:
    disable: false
    privacyEnhanced: false

[privacy]
  [privacy.youTube]
    disable = false
    privacyEnhanced = false

{
   "privacy": {
      "youTube": {
         "disable": false,
         "privacyEnhanced": false
      }
   }
}

disable: (bool) Whether to disable the shortcode. Default is false.
privacyEnhanced: (bool) Whether to block YouTube from storing information about visitors on your website unless the user plays the embedded video. Default is false.