💎 Liquid tag for embedding asciicasts recorded with asciinema for use in Jekyll sites.
Ruby Shell
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.

README.md

Jekyll::Asciinema

Build Status Coverage Status Gem Version Dependency Status Code Climate Gem License

Provides a Liquid tag for embedding asciicasts recorded with asciinema for use in Jekyll sites.

Installation

Add this line to your application's Gemfile:

gem 'jekyll-asciinema'

And then execute:

$ bundle

Or install it yourself as:

$ gem install jekyll-asciinema

Usage

Use the tag as follows in your Jekyll pages and posts:

{% asciicast 123 %}

This will render the associated script tag:

<script type="text/javascript" src="https://asciinema.org/a/123.js" id="asciicast-123" async="async"></script>

Replace "123" with the real ID of the asciicast to embed.

Development

After checking out the repo, run bin/setup to install dependencies. Then, 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 to create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.

Contributing

  1. Fork it ( https://github.com/mnuessler/jekyll-asciinema/fork )
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create a new Pull Request

License

Code is under MIT License.