Giter Club home page Giter Club logo

jekyll-slim's Introduction

Jekyll-slim

Gem Version Dependency Status Code Climate Build Status

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

This fork is trying to fix jekyll-slim for the current version.

Installation

Add this line to your Gemfile:

gem 'jekyll-slim', github: 'vaz/jekyll-slim'
gem 'sliq', github: 'vaz/sliq'

And then execute:

$ bundle

In your Jekyll project's _plugins directory:

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

This is currently working with jekyll-2.5.2, slim-2.1.0, and my own fork of sliq.

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 }}
# index.slim
---
layout: default
---

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

Options

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

# _config.yml
slim:
  pretty: true

Context

This fork removes the SlimContext addition which made the site's configuration available in ruby expressions in the slim code. It didn't seem necessary and complicated things.

Looking for maintainers

The original authors are looking for maintainers for the 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.

This fork borrows the preconverter hack from the northdocks fork

jekyll-slim's People

Contributors

fire-dragon-dol avatar minad avatar vaz avatar

Watchers

 avatar  avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.