jekyll-ipa

Jekyll::Ipa

All this gem does is surround your International Phonetic Alphabet text with the following code snippet:

<abbr title="International Phonetic Alphabet">IPA</abbr>: <span class="ipa">[your input here]</span>

and give it a little bit of styling to offset it from the surrounding text. This plugin is meant for use with the PaperWiki Jekyll theme.

Installation

Add this line to your application's Gemfile:

gem 'jekyll-ipa'

And then execute:

$ bundle install

Or install it yourself as:

$ gem install jekyll-ipa

Usage

{% ipa [phonetic transcription here] %}
{% ipa /phonemic transcription here/ %}

It is not necessary to surround the transcription in quotes.

Development

After checking out the repo, run bin/setup to install dependencies. You can also run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and the created tag, and push the .gem file to rubygems.org.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/jekyll-ipa.

License

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