Skip to content

babel/jekyll-babel

Repository files navigation

Jekyll::Babel

A Babel converter for Jekyll.

Build Status

Based on jekyll-coffeescript by @parkr.

Installation

Add this line to your application's Gemfile:

gem 'jekyll-babel'

Then execute:

$ bundle

You may also skip using a Gemfile and install it yourself as:

$ gem install jekyll-babel

Finally, in you Jekyll's _config.yml file, add:

gems:
  - jekyll-babel

Notes: jekyll-babel requires Ruby 1.9.3 or greater. Additionally, the dependency on execjs means you must also have a valid JavaScript runtime available to your project

Usage

In your Jekyll site, create Babel-aware files that start with the following lines:

---
---

You need those three dashes in order for Jekyll to recognize it as "convertible". They won't be included in the content passed to the Babel compiler.

Options

Files with extensions .js, .es6, .babel and .jsx will be processed. You may customize the list of white-listed extensions in your _config.yml, by providing a string of comma-separated values:

babel_js_extensions: 'es6, babel, jsx' # Do not process .js files

Contributing

  1. Fork it (http://github.com/thejameskyle/jekyll-babel/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 new Pull Request