https://github.com/slim-template/jekyll-slim

A gem that adds slim-lang support to Jekyll.
https://github.com/slim-template/jekyll-slim

Last synced: about 2 months ago
JSON representation

A gem that adds slim-lang support to Jekyll.

• Host: GitHub
• URL: https://github.com/slim-template/jekyll-slim
• Owner: slim-template
• License: mit
• Archived: true
• Fork: true (sunnyrjuneja/jekyll-slim)
• Created: 2014-08-02T22:33:57.000Z (about 10 years ago)
• Default Branch: master
• Last Pushed: 2019-03-06T16:58:29.000Z (over 5 years ago)
• Last Synced: 2024-06-19T03:04:58.968Z (3 months ago)
• Language: CSS
• Size: 46.9 KB
• Stars: 33
• Watchers: 9
• Forks: 18
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • Changelog: History.md
  • License: LICENSE.txt

Awesome Lists containing this project

• awesome-jekyll-plugins - **Slim** - slim](https://rubygems.org/gems/jekyll-slim) -- Slim converter and includes for Jekyll with support for Liquid tags. **Archived** (Markup & Markdown Converters)

README

        
# Jekyll-slim

[![Gem Version](http://img.shields.io/gem/v/jekyll-slim.svg?style=flat)](#)

[![Dependency

Status](http://img.shields.io/gemnasium/slim-template/jekyll-slim.svg?style=flat)](https://gemnasium.com/slim-template/jekyll-slim)

[![Code

Climate](http://img.shields.io/codeclimate/github/slim-template/jekyll-slim.svg?style=flat)](https://codeclimate.com/github/slim-template/jekyll-slim)

[![Build Status](http://img.shields.io/travis/slim-template/jekyll-slim.svg?style=flat)](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

Add this line to your Gemfile:

    gem 'jekyll-slim'

    gem 'slim', github: 'slim-template/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!

This gem requires slim from the github master branch for now.

## 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 }}

```

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

```slim

# 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:

```yaml

# _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:

```slim

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.

## Looking for maintainers

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.