Skip to main content

Video tag generator markdown extension

Project description

Vidify - convert img tags to html5 video tags

Vidify is a plugin for Python's Markdown that allows you to embed html5 video into your document. It's inteneded for Python 3.6 + but is probably back-compatible with 2.7.

Vidifiy works by detecting <img> tags pointing at a file with an extension of .webm, .mp4, or .ogg and replacing them with <video> tags.

Installing

Simply install from PyPi:

pip install markdown-vidify

Usage

Simply import the package and then pass it to the extensions parameter of markdown!

import markdown
import markdown_vidify

# ...

ouptut = markdown.markdown(input, extensions=[
    markdown_vidify.VidifyExtension(
        autoplay=False,
        controls=True,
        loop=False,
        mute=False,
    )
])

Options

All default to false:

  • autoplay - Autoplay the video once page is loaded
  • controls - Display player controls below the video
  • loop - Loop the video
  • mute - Video is muted by default

Extra Hints!

Consider using the Attribute List plugin that comes with markdown to set the html5 poster attribute. This will be an image that displays in-place of your video while it is downloading or until the user hits the play button!

![alt](/path/to/video.webm){: poster="/path/to/image.png"}

Weird Caveat

Since html5 video doesn't have an alt-text, the body of the [] is entirely ignored. Other plugins may still use it however. I am aware of how -janky- this is. I considered using it for the poster tag but that still feels janky and it would also interfere with other markdown plugins. If you feel you haev a good usgesstion feel free to post it as an issue.

Boring Stuff

vidify was written by Jason Hamilton-Smith <hs.jason@gmail.com>, my website is zchfvy.com.

This project is licensed under the GPL v3.0 license. See the LICENSE file for details.

Project details


Download files

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

Files for markdown-vidify, version 0.1.1
Filename, size File type Python version Upload date Hashes
Filename, size markdown_vidify-0.1.1-py3-none-any.whl (17.8 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size markdown-vidify-0.1.1.tar.gz (3.7 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page