YouTube shortcode

[!note] 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:

{{< youtube 0RKpf3rK57I >}}

Arguments

id : (string) The video id. Optional if the id is the first and only positional argument.

allowFullScreen : (bool) Whether the iframe element can activate full screen mode. Default is true.

autoplay : (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 : (bool) Whether to display the video controls. Default is true.

end : (int) The time, measured in seconds from the start of the video, when the player should stop playing the video.

loading : (string) The loading attribute of the iframe element, either eager or lazy. Default is eager.

loop : (bool) Whether to indefinitely repeat the video. Ignores the start and end arguments after the first play. Default is false.

mute : (bool) Whether to mute the video. Always true when autoplay is true. Default is false.

start : (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 */>}}

Privacy

Adjust the relevant privacy settings in your project configuration.

{{< code-toggle config=privacy.youTube />}}

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.

[source code]: {{% eturl youtube %}}