Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/babel/jekyll-babel
A Babel converter for Jekyll.
https://github.com/babel/jekyll-babel
Last synced: 3 months ago
JSON representation
A Babel converter for Jekyll.
- Host: GitHub
- URL: https://github.com/babel/jekyll-babel
- Owner: babel
- License: mit
- Created: 2015-08-26T17:29:40.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2019-06-21T03:58:20.000Z (over 5 years ago)
- Last Synced: 2024-04-14T01:34:06.821Z (9 months ago)
- Language: Ruby
- Size: 8.79 KB
- Stars: 34
- Watchers: 4
- Forks: 12
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Changelog: History.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Jekyll::Babel
A Babel converter for Jekyll.
[](https://travis-ci.org/babel/jekyll-babel)
> Based on [jekyll-coffeescript](https://github.com/jekyll/jekyll-coffeescript) by @parkr.
## Installation
Add this line to your application's Gemfile:
```ruby
gem 'jekyll-babel'
```
Then execute:
```bash
$ bundle
```
You may also skip using a Gemfile and install it yourself as:
```bash
$ gem install jekyll-babel
```
Finally, in you Jekyll's \_config.yml file, add:
```yml
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](https://github.com/sstephenson/execjs#execjs) 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:
```yml
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