README.md in jekyll-slim-0.9.1 vs README.md in jekyll-slim-0.10.0
- old
+ new
@@ -1,13 +1,13 @@
# Jekyll-slim
[](#)
[](https://gemnasium.com/kaishin/jekyll-slim)
+Status](http://img.shields.io/gemnasium/slim-template/jekyll-slim.svg?style=flat)](https://gemnasium.com/slim-template/jekyll-slim)
[](https://codeclimate.com/github/kaishin/jekyll-slim)
-[](https://travis-ci.org/kaishin/jekyll-slim)
+Climate](http://img.shields.io/codeclimate/github/slim-template/jekyll-slim.svg?style=flat)](https://codeclimate.com/github/slim-template/jekyll-slim)
+[](https://travis-ci.org/slim-template/jekyll-slim)
A gem that adds [slim-lang](http://slim-lang.com) support to [Jekyll](http://github.com/mojombo/jekyll). Works for for pages, includes and layouts.
## Installation
@@ -23,37 +23,34 @@
$ gem install jekyll-slim
In your Jekyll project's `_plugins` directory:
- # _plugins/bundler.rb
- require 'rubygems'
- require 'bundler/setup'
- Bundler.require(:default)
+ # _plugins/jekyll-slim.rb
+ require 'jekyll-slim'
## Usage
The gem will convert all the `.slim` files in your project's directory into HTML. That includes files in sub-directories, includes and layouts. Example:
```slim
# _layouts/default.slim
html
head
body
- .content-wrapper
- | {{ content }}
+ .content-wrapper {{ content }}
```
To include a partial, use the `slim` liquid tag instead of `include`:
```slim
# index.slim
---
layout: default
---
section.content Content goes here.
-| {% slim footer.slim %}
+% include footer.slim
```
### Options
@@ -82,19 +79,12 @@
The `SlimContext` object will be kept across calls, allowing you to easily set
`@instance_variables` that can be accessed by **all slim files** even those included with the `slim`
liquid tag. Those are more or less global variables in slim templates, so be careful when you use them.
-## TODO
+## Looking for maintainers
-- Per-page slim context?
-- Improve code and try to avoid patches as much as possible
-- Parsing Liquid tags before slim so you have access to everything? Can create a lot of problems with Ruby
-- Slim context must be the same as liquid, with paginator, site, page and content variables. See these links:
- - https://github.com/mojombo/jekyll/blob/a9e2a74ea619a01a9d169da2240ce91b43362c9f/lib/jekyll/tags/include.rb
- - https://github.com/mojombo/jekyll/blob/a9e2a74ea619a01a9d169da2240ce91b43362c9f/lib/jekyll/page.rb
- - http://jekyllrb.com/docs/plugins/
- - http://jekyllrb.com/docs/variables/
+We are looking for maintainers for this gem.
## Credit
Jekyll-slim was heavily inspired by [jekyll-haml](https://github.com/samvincent/jekyll-haml). It is free software, and may be redistributed under the terms specified in the LICENSE file.