https://github.com/mnuessler/jekyll-asciinema

:gem: Liquid tag for embedding asciicasts recorded with asciinema for use in Jekyll sites.
https://github.com/mnuessler/jekyll-asciinema

asciinema jekyll liquid-templating-engine

Last synced: 2 months ago
JSON representation

:gem: Liquid tag for embedding asciicasts recorded with asciinema for use in Jekyll sites.

• Host: GitHub
• URL: https://github.com/mnuessler/jekyll-asciinema
• Owner: mnuessler
• License: mit
• Created: 2015-03-17T22:41:07.000Z (over 9 years ago)
• Default Branch: master
• Last Pushed: 2023-07-11T14:54:58.000Z (over 1 year ago)
• Last Synced: 2024-04-24T17:40:00.439Z (8 months ago)
• Topics: asciinema, jekyll, liquid-templating-engine
• Language: Ruby
• Homepage: https://rubygems.org/gems/jekyll-asciinema
• Size: 32.2 KB
• Stars: 39
• Watchers: 3
• Forks: 5
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE.txt

Awesome Lists containing this project

• awesome-jekyll-plugins - **Asciinema** - asciinema](https://rubygems.org/gems/jekyll-asciinema)) -- a tag for embedding asciicasts recorded with asciinema in your Jekyll pages. (Videos & Screencasts)

README

        
# Jekyll::Asciinema

[![.github/workflows/gem-build.yml][badge-build]][build]

[![Gem Version][badge-gem]][rubygems]

[![Gem][badge-dl]][rubygems]

[![Coverage Status][badge-coveralls]][coveralls]

[![Code Climate][badge-gpa]][codeclimate]

[![License][badge-license]][license]

Provides a [Liquid][liquid] tag for embedding asciicasts recorded with

[asciinema][asciinema] for use in [Jekyll][jekyll] sites.

## Installation

Add this line to your application's Gemfile:

```ruby

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:

    

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](https://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][license].

[badge-build]: https://github.com/mnuessler/jekyll-asciinema/actions/workflows/gem-build.yml/badge.svg

[badge-coveralls]: https://coveralls.io/repos/mnuessler/jekyll-asciinema/badge.svg

[badge-gem]: https://badge.fury.io/rb/jekyll-asciinema.svg

[badge-gpa]: https://codeclimate.com/github/mnuessler/jekyll-asciinema/badges/gpa.svg

[badge-license]: https://img.shields.io/github/license/mnuessler/jekyll-asciinema.svg?maxAge=604800

[badge-dl]: https://img.shields.io/gem/dt/jekyll-asciinema.svg?maxAge=604800

[build]: https://github.com/mnuessler/jekyll-asciinema/actions/workflows/gem-build.yml

[coveralls]: https://coveralls.io/r/mnuessler/jekyll-asciinema

[rubygems]: https://rubygems.org/gems/jekyll-asciinema

[gemnasium]: https://gemnasium.com/mnuessler/jekyll-asciinema

[codeclimate]: https://codeclimate.com/github/mnuessler/jekyll-asciinema

[liquid]: http://liquidmarkup.org "Liquid templating language"

[asciinema]: https://asciinema.org "Asciinema"

[jekyll]: http://jekyllrb.com "Jekyll"

[license]: https://raw.githubusercontent.com/mnuessler/jekyll-asciinema/master/LICENSE.txt