Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/kura/pelican_youtube
YouTube directives for the Pelican static site generator.
https://github.com/kura/pelican_youtube
pelican youtube
Last synced: 12 days ago
JSON representation
YouTube directives for the Pelican static site generator.
- Host: GitHub
- URL: https://github.com/kura/pelican_youtube
- Owner: kura
- License: mit
- Created: 2013-08-09T13:08:58.000Z (over 11 years ago)
- Default Branch: main
- Last Pushed: 2021-08-31T02:05:16.000Z (about 3 years ago)
- Last Synced: 2024-11-01T03:22:50.598Z (19 days ago)
- Topics: pelican, youtube
- Language: Python
- Homepage: https://kura.gg/pelican-youtube/
- Size: 18.6 KB
- Stars: 28
- Watchers: 3
- Forks: 11
- Open Issues: 0
-
Metadata Files:
- Readme: README.rst
- License: LICENSE
Awesome Lists containing this project
README
===============
Pelican YouTube
===============
Pelican YouTube is a plugin to enabled you to embed YouTube videos in your pages
and articles.
Installation
============
Pip
---
To install pelican-youtube, simply install it from PyPI:
.. code-block:: bash
$ pip install pelican-youtube
Then enable it in your pelicanconf.py
.. code-block:: python
PLUGINS = [
# ...
'pelican_youtube',
# ...
]
Local plugins directory
-----------------------
.. code-block:: bash
$ mkdir plugins
$ git clone [email protected]:kura/pelican_youtube.git plugins/pelican_youtube
Then enable it in your pelicanconf.py
.. code-block:: python
PLUGIN_PATHS = ["plugins/"]
PLUGINS = [
# ...
'pelican_youtube',
# ...
]
Usage
=====
In your article or page, you simply need to add a line to embed your video.
.. code-block:: rst
.. youtube:: VIDEO_ID
Which will result in:
.. code-block:: html
.. note::
This code will render you a fully responsive YouTube video, spanning the
whole available container width. Note that you will need to integrate the
code from `youtube.css`_ in your project or template style sheet.
Alternatively, you can specify `width` and `height` as detailed below.
.. _youtube.css: https://github.com/kura/pelican_youtube/blob/master/youtube.css
Additional arguments
--------------------
+-------------------+------------------+---------------------------------------------------------+
| Attribute | default | |
+===================+==================+=========================================================+
| `allowfullscreen` | ``yes`` | allow video to be displayed full-screen |
+-------------------+------------------+---------------------------------------------------------+
| `seamless` | ``yes`` | no borders around iframe |
+-------------------+------------------+---------------------------------------------------------+
| `class` | ``youtube-16x9`` | additional CSS classes, usually for responsive behavior |
+-------------------+------------------+---------------------------------------------------------+
| | empty° | (° when `width` or `height` are specified) |
+-------------------+------------------+---------------------------------------------------------+
| `width`, `height` | empty | video dimensions when responsive design is not desired |
+-------------------+------------------+---------------------------------------------------------+
Example 1: (responsive design)
.. code-block:: rst
.. youtube:: 4_X6EyqXa2s
:class: youtube-4x3
:allowfullscreen: no
:seamless: no
Will result in:
.. code-block:: html
Example 2: (non-responsive design)
.. code-block:: rst
.. youtube:: 4_X6EyqXa2s
:width: 800
:height: 500
:allowfullscreen: no
Will result in:
.. code-block:: html
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)
.. code-block:: rst
.. youtube:: 4_X6EyqXa2s?start=20&autoplay=1&rel=0
.. _YouTube documentation: https://developers.google.com/youtube/player_parameters#Parameters
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.
License
=======
`MIT`_ license.
.. _MIT: http://opensource.org/licenses/MIT