Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jekyll/jekyll-coffeescript
A CoffeeScript converter for Jekyll.
https://github.com/jekyll/jekyll-coffeescript
coffeescript jekyll-plugin
Last synced: 18 days ago
JSON representation
A CoffeeScript converter for Jekyll.
- Host: GitHub
- URL: https://github.com/jekyll/jekyll-coffeescript
- Owner: jekyll
- License: mit
- Created: 2014-01-25T23:39:39.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2020-12-24T10:14:26.000Z (over 3 years ago)
- Last Synced: 2024-06-06T18:59:47.989Z (22 days ago)
- Topics: coffeescript, jekyll-plugin
- Language: Ruby
- Size: 73.2 KB
- Stars: 50
- Watchers: 9
- Forks: 20
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: History.markdown
- License: LICENSE.txt
Lists
- awesome-jekyll-plugins - **Coffeescript** - coffeescript](https://rubygems.org/gems/jekyll-coffeescript)) -- a CoffeeScript converter **#Official** (Assets & Converters & Minifiers)
- awesome_jekyll_plugins - **Coffeescript** - coffeescript](https://rubygems.org/gems/jekyll-coffeescript)) -- a CoffeeScript converter **#Official** (Assets & Converters & Minifiers)
- awesome-lists-awesome-jekyll-plugins - **Coffeescript** - coffeescript](https://rubygems.org/gems/jekyll-coffeescript)) -- a CoffeeScript converter **#Official** (Assets & Converters & Minifiers)
README
# Jekyll::Coffeescript
A CoffeeScript converter for Jekyll.
[](https://travis-ci.org/jekyll/jekyll-coffeescript)
## Installation
Add this line to your application's Gemfile:
```ruby
gem 'jekyll-coffeescript'
```
And then execute:
```bash
$ bundle
```
Or install it yourself as:
```bash
$ 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](https://github.com/rails/execjs#execjs) 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