README.md

docsify-gifcontrol

A docsify plugin that adds customizable player controls to GIFs. GIFs will play on hover or on click depending on your configuration.

Full Documentation with live examples at https://gbodigital.github.io/docsify-gifcontrol

Quick Start

Add the CSS file to the top of your docsify index.html

<link rel="stylesheet" href="//unpkg.com/docsify-gifcontrol/dist/docsify-gifcontrol.css">

Add the JavaScript file below your docsify script tag

<script src="//unpkg.com/docsify-gifcontrol/dist/docsify-gifcontrol.js"></script>

Add a GIF in your markdown

![](docs/charlie.gif)

Examples

Hover to play (default)

<!-- Hover to play, unhover to pause (default) -->
![](charlie.gif)

Click to play

<!-- Click to play, click again to pause (using inline option) -->
![](charlie2.gif "-gifcontrol-mode=click;")

Customization

You can customize almost everything about the player. For more information see the Configuration section.

<!-- Customize colors and icons -->
![](charlie3.gif "-gifcontrol-iconColor=#ff0000; -gifcontrol-overlayColor=rgba(0,0,0,0.7); -gifcontrol-playIcon=<svg xmlns=\"http://www.w3.org/2000/svg\" viewBox=\"0 0 512 512\"><path d=\"M462.3 62.6C407.5 15.9 326 24.3 275.7 76.2L256 96.5l-19.7-20.3C186.1 24.3 104.5 15.9 49.7 62.6c-62.8 53.6-66.1 149.8-9.9 207.9l193.5 199.8c12.5 12.9 32.8 12.9 45.3 0l193.5-199.8c56.3-58.1 53-154.3-9.8-207.9z\"/></svg>;")

Additional customization

More customization examples can be found in the Configuration section. You can also check out the source of this documentation in the docs folder on Github.

Excluding Images

By default all GIFs in image tags will be parsed to use the player overlay unless they fall in to one of the four categories below:

• Image tags with the .emoji class are ignored
• Image tags with a data-gifcontrol-disabled attribute are ignored
• Image tags that do not contain the .gif string in their src attribute are ignored
• Images created with markdown that have the -gifcontrol-disabled; option in the title component of the image markdown are ignored

Example

<!-- The plugin will ignore the gif below -->
![](charlie.gif "-gifcontrol-disabled;")

Attributions

• omggif written by Dean McNamee under MIT License is used to load GIF file data
• A customized version of gifler written by Bill Dwyer under Apache 2.0 License is used to render GIFs to an HTML canvas element
• The SVG icons used in the code and documentation are from the FontAwesome Free Icon Pack licensed under the Creative Commons 4.0 BY License

License

Except where otherwise noted, this software is licensed under the MIT license. Please see the the documentation for more information.