0.02
No commit activity in last 3 years
No release in over 3 years
Let Jekyll convert your Ruby into JavaScript using Opal.
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Dependencies

Development

~> 1.6
>= 2.0
>= 0
~> 3.0

Runtime

~> 0.8
 Project Readme

Jekyll-Opal

Let Jekyll convert your Ruby into JavaScript using Opal.

Build Status

Installation

Add this line to your application's Gemfile:

gem 'jekyll-opal'

And then execute:

$ bundle

Or install it yourself as:

$ gem install jekyll-opal

Usage

Write your Opal in .opal files (be sure to add the two --- lines at the top to make them pages!!)

This plugin comes with a generator which creates the Opal library file in the destination, under js/opal.js, if it's not already there. To prevent backwards-incompatible sites, we ship a {{ site.opal.url }} variable for your use in your sites. When output, it will look like this: /js/opal.js.

If your site is served in a subfolder (i.e. http://example.org/subfolder/), simply prepend a baseurl:

<script src="{{ site.opal.url | prepend:"my_subfolder" }}"></script>

You can even prepend variables! Perhaps a URL?

<script src="{{ site.opal.url | prepend:"my_subfolder" | prepend:site.url }}"></script>

Feel free to chain them like that -- they're just Liquid filters.

File an issue if something isn't clear!

Contributing

  1. Fork it ( https://github.com/jekyll/jekyll-opal/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

MIT. See the License file for more details