A docsify plugin that adds customizable player controls to GIFs
npm install docsify-gifcontrolFull Documentation with live examples at
https://gbodigital.github.io/docsify-gifcontrol
Add the CSS file to the top of your docsify index.html
``html`
Add the JavaScript file below your docsify script tag
`html`
Add a GIF in your markdown
`markdown`
#### Hover to play (default)
`markdown`
#### Click to play
`markdown`
#### Customization
You can customize almost everything about the player. For more information see the Configuration section.
`markdown`
#### 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.
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 ignoreddata-gifcontrol-disabled
- Image tags with a attribute are ignored.gif
- Image tags that do not contain the string in their src attribute are ignored-gifcontrol-disabled;
- Images created with markdown that have the option in the title component of the image markdown are ignored
#### Example
`markdown``
- 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
Except where otherwise noted, this software is licensed under the MIT license. Please see the the documentation for more information.