No commit activity in last 3 years
No release in over 3 years
A minimal audio plugin for Jekyll, with HTML5 audio elemnt.
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
 Dependencies

Development

~> 1.16
~> 5.0
~> 10.0

Runtime

~> 3.8
 Project Readme

Jekyll::Miniaudio

A minimal audio plugin for Jekyll.

The implementation is based on HTML5 audio element (without fallback support for flash), so a morden browser is expected.

Audio formats support also depends on browsers, but generally mp3, wav, ogg are supported.

See Live Demo

Installation

  • In your Jekyll project's Gemfile:
      group :jekyll_plugins do
          ...   # other plugins
          jekyll-miniaudio # add here
      end
    then bundle install.

Usage

This plugin is a Jekyll Tag, you just pass either an audio link or file path.

  • Use with audio link:

    {% miniaudio 'https://somewhere/themusic.mp3' %}

  • Use with file path. For example if you have a demo.ma3 located in your assets/music folder, then just put:

    {% miniaudio '/assets/music/demo.mp3' %}

    ** Note: Ensure your file is accessible via http(s)://YOUR_HOST/assets/demo.mp3**

Issues and feature requests

Feel free to create issues or send me email hailengc@gmail.com.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/hailengc/jekyll-miniaudio.

License

The gem is available as open source under the terms of the MIT License.