theworkerant / jekyll-slim

A gem that adds slim-lang support to Jekyll.

Jekyll-slim

A gem that adds slim-lang support to Jekyll. Works for for pages, includes and layouts.

Installation

Add this line to your Gemfile:

gem 'jekyll-slim'

And then execute:

$ bundle

Or install it yourself as:

$ gem install jekyll-slim

In your Jekyll project's _plugins directory:

# _plugins/jekyll-slim.rb
require 'jekyll-slim'

Important notes

Right now it's required to use these additional lines in Gemfile (as of version 0.10.0):

gem 'sliq', github: 'slim-template/sliq'

Until those gems are updated

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:

# _layouts/default.slim
html
  head
  body
    .content-wrapper {{ content }}

To include a partial, use the slim liquid tag instead of include:

# index.slim
---
layout: default
---

section.content Content goes here.
% include footer.slim

Options

Is possible to set options available for Slim engine through the slim key in _config.yml. Example:

# _config.yml
slim:
  pretty: true
  format: html5

Context

The slim context is set to acess a SlimContext object which has a site method, used to access config. Be careful because this is a breaking change.

This allows you to access configuration information in your slim file. Example:

html
  head
  body
    .content-wrapper
      = "slim pretty mode: #{ site.config['slim']['pretty'].to_s }"

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

• 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/

Looking for maintainers

We are looking for maintainers for this gem.

Credit

Jekyll-slim was heavily inspired by jekyll-haml. It is free software, and may be redistributed under the terms specified in the LICENSE file.