Skip to content

jekyll/jekyll-coffeescript

master
Switch branches/tags

Name already in use

A tag already exists with the provided branch name. Many Git commands accept both tag and branch names, so creating this branch may cause unexpected behavior. Are you sure you want to create this branch?
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
lib
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Jekyll::Coffeescript

A CoffeeScript converter for Jekyll.

Build Status

Installation

Add this line to your application's Gemfile:

gem 'jekyll-coffeescript'

And then execute:

$ bundle

Or install it yourself as:

$ gem install jekyll-coffeescript

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

You also need to add this plugin to your _config.yml file:

plugins:
  - jekyll-coffeescript

Usage

In your Jekyll site, create CoffeeScript 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 CoffeeScript compiler.

Contributing

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