https://github.com/kura/pelican_vimeo

Vimeo directives for the Pelican static site generator.
https://github.com/kura/pelican_vimeo

pelican vimeo

Last synced: about 1 month ago
JSON representation

Vimeo directives for the Pelican static site generator.

• Host: GitHub
• URL: https://github.com/kura/pelican_vimeo
• Owner: kura
• License: mit
• Created: 2013-08-09T13:00:05.000Z (over 11 years ago)
• Default Branch: main
• Last Pushed: 2021-08-26T12:40:33.000Z (about 3 years ago)
• Last Synced: 2024-09-26T18:07:10.247Z (about 2 months ago)
• Topics: pelican, vimeo
• Language: Python
• Homepage: https://kura.gg/pelican-vimeo/
• Size: 20.5 KB
• Stars: 3
• Watchers: 3
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.rst
  • License: LICENSE

Awesome Lists containing this project

README

        
=============

Pelican Vimeo

=============

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:

.. code-block:: bash

    $ pip install pelican-vimeo

Then enabled it in your pelicanconf.py

.. code-block:: python

    PLUGINS = [

        # ...

        'pelican_vimeo',

        # ...

    ]

Usage

=====

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

.. code-block:: rst

    .. vimeo:: VIDEO_ID

Which will result in:

.. code-block:: html

    


    

    


Additional arguments

--------------------

You can also specify a `width`, `height` and `alignment`

.. code-block:: rst

    .. vimeo:: 37818131

            :width: 800

            :height: 500

            :align: center

Which will result in:

.. code-block:: html

    


    

    


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.

.. _MIT: http://opensource.org/licenses/MIT