Skip to main content

Easily embed Vimeo videos in your posts

Project description

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

Installation

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

$ pip install pelican-vimeo

Then enabled it in your pelicanconf.py

PLUGINS = [
    # ...
    'pelican_vimeo',
    # ...
]

Usage

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

.. vimeo:: VIDEO_ID

Which will result in:

<div class="vimeo" align="left">
<iframe width="420" height="315" src="https://player.vimeo.com/video/VIDEO_ID" frameborder="0"
webkitallowfullscreen mozallowfullscreen allowfullscreen></iframe>
</div>

Additional arguments

You can also specify a width, height and alignment

.. vimeo:: 37818131
        :width: 800
        :height: 500
        :align: center

Which will result in:

<div class="vimeo" align="center">
<iframe width="800" height="500" src="https://player.vimeo.com/video/37818131" frameborder="0"
webkitallowfullscreen mozallowfullscreen allowfullscreen></iframe>
</div>

Additionally, this plugin allows to specify the following Vimeo player URL parameters as options (values are passed through):

  • autopause
  • autoplay
  • background
  • byline
  • color
  • controls
  • dnt
  • fun
  • loop
  • muted
  • playsinline
  • portrait
  • quality
  • speed
  • t
  • texttrack
  • title
  • transparent

If you encounter Vimeo player URL parameters not supported by this plugin, you can also specify those appended to the video ID (e.g., .. vimeo:: 37818131?another_option=another_value&foo=bar).

License

MIT license.

Download files

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

Files for pelican-vimeo, version 0.1.2
Filename, size File type Python version Upload date Hashes
Filename, size pelican_vimeo-0.1.2-py2.py3-none-any.whl (7.4 kB) File type Wheel Python version py2.py3 Upload date Hashes View
Filename, size pelican_vimeo-0.1.2.tar.gz (4.5 kB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring DigiCert DigiCert EV certificate Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page