Skip to main content

Easily embed YouTube videos in your posts

Project description

Pelican YouTube is a plugin to enabled you to embed YouTube videos in your pages and articles.


To install pelican-youtube, simply install it from PyPI:

$ pip install pelican-youtube

Then enable it in your

    # ...
    # ...


In your article or page, you simply need to add a line to embed your video.

.. youtube:: VIDEO_ID

Which will result in:

<div class="youtube youtube-16x9">
<iframe src="" allowfullscreen seamless frameBorder="0"></iframe>

Additional arguments





allow video to be displayed full-screen



no borders around iframe



additional CSS classes, usually for responsive behavior


(° when width or height are specified)

width, height


video dimensions when responsive design is not desired

Example 1: (responsive design)

.. youtube:: 4_X6EyqXa2s
    :class: youtube-4x3
    :allowfullscreen: no
    :seamless: no

Will result in:

<div class="youtube youtube-4x3">
<iframe src=""></iframe>

Example 2: (non-responsive design)

.. youtube:: 4_X6EyqXa2s
    :width: 800
    :height: 500
    :allowfullscreen: no

Will result in:

<div class="youtube">
<iframe width="800" height="500" src="" seamless frameBorder="0"></iframe>

More Control of YouTube Video Player

YouTube offers more control via player parameters, which you simply attach to the VIDEO_ID as query parameters. See YouTube documentation for a list of possible parameters.

Example: (start video at time 00:20, start playing automatically, don’t show related content at end of video)

.. youtube:: 4_X6EyqXa2s?start=20&amp;autoplay=1&amp;rel=0

Known Issues

The presence of the frameBorder attribute causes an HTML5 validation error. Unfortunately, this attribute is still necessary for supporting older versions of Internet Explorer.


MIT license.

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pelican_youtube-0.2.1.tar.gz (5.0 kB view hashes)

Uploaded Source

Built Distribution

pelican_youtube-0.2.1-py2.py3-none-any.whl (8.1 kB view hashes)

Uploaded Python 2 Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page