• Stars
    star
    148
  • Rank 241,640 (Top 5 %)
  • Language
    Crystal
  • License
    MIT License
  • Created about 8 years ago
  • Updated almost 2 years ago

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

Generic template interface for Crystal

Kilt Build Status

Generic templating interface for Crystal.

Goal

Simplify developers' lives by abstracting template rendering for multiple template languages.

Supported out of the box

Language File extensions Required libraries Maintainer
ECR .ecr none (part of the stdlib)
Mustache .mustache crustache @MakeNowJust
Slang .slang slang @jeromegn
Temel .temel temel @f
Crikey .crikey crikey @domgetter
Liquid .liquid liquid @docelic
Jbuilder .jbuilder jbuilder @shootingfly
Water .water water @shootingfly

See also: Registering your own template engine.

Installation

Add this to your application's shard.yml:

dependencies:
  kilt:
    github: jeromegn/kilt

  # Any other template languages Crystal shard

Usage

  • Kilt essentially adds two macros Kilt.embed and Kilt.file, the code is really simple.
  • Add template language dependencies, as listed in the support table above.

Both macros take a filename and a io_name (the latter defaults to "__kilt_io__")

Example

require "kilt"

# For slang, add:
require "kilt/slang"

# With a Class

class YourView
  Kilt.file("path/to/template.ecr") # Adds a to_s method
end
puts YourView.new.to_s # => <compiled template>


# Embedded

str = Kilt.render "path/to/template.slang"

# or

str = String.build do |__kilt_io__|
  Kilt.embed "path/to/template.slang"
end

puts str # => <compiled template>

Registering your own template engine

Use Kilt.register_engine(extension, embed_command) macro:

require "kilt"

module MyEngine
  macro embed(filename, io_name)
    # ....
  end
end

Kilt.register_engine("myeng", MyEngine.embed)

This can be part of your own my-engine library: in this case it should depend on kilt directly, or this could be a part of adapter library, like: kilt-my-engine, which will depend on both kilt and my-engine.

Contributing

Please contribute your own "adapter" if you create a template language for Crystal that's not yet supported here!

  1. Fork it ( https://github.com/jeromegn/kilt/fork )
  2. Create your feature branch (git checkout -b my-awesome-template-language)
  3. Commit your changes (git commit -am 'Add my-awesome-template-language')
  4. Push to the branch (git push origin my-awesome-template-language)
  5. Create a new Pull Request

Contributors

More Repositories

1

Backbone.localStorage

A localStorage adapter for Backbone.js
JavaScript
1,899
star
2

DocumentUp

Pretty documentation generator for Github projects with proper Readme.
Ruby
886
star
3

slang

Slim-inspired templating language for Crystal
Crystal
232
star
4

localtodos

Simple Todos App built on Backbone.js
JavaScript
99
star
5

protobuf.cr

Protobuf generator, encoder and decoder.
Crystal
95
star
6

poutine

MongoDB ORM for Node.js
CoffeeScript
35
star
7

docker.cr

Docker API client in Crystal.
Crystal
26
star
8

influxdb.cr

InfluxDB driver for Crystal
Crystal
25
star
9

bson.cr

BSON implementation written in Crystal
Crystal
24
star
10

v8.cr

V8 bindings for Crystal
C++
16
star
11

dry-types-rails

Dry::Types railties
Ruby
11
star
12

beautifier

A safari extension which smooths fonts!
10
star
13

Warping-Shadow-CSS3

Warping Shadows can be done in CSS3
Ruby
8
star
14

mongol

Light modeling for MongoDB.
JavaScript
8
star
15

jeromegn.github.com

Personal site
HTML
5
star
16

rapid

Redis ORM-ish api for nodejs
JavaScript
3
star
17

backbone.pjax

Backbone utilities for web apps using PJAX.
JavaScript
3
star
18

rhai-tpl

Simple template engine using rhai for logic
Rust
2
star
19

qml.cr

QML library for Crystal
Crystal
2
star
20

quinn-plaintext

QUIC pluggable crypto to use the protocol as plaintext (for use when cryptography is already handled at another layer, e.g. Wireguard)
Rust
1
star
21

Radiophonique

Objective-C
1
star
22

containerd-rs

Rust
1
star
23

lg-ultrafine-brightness

Control LG Ultrafine brightness on linux
Rust
1
star
24

documentup.js

experimental DocumentUp running on fly.io
JavaScript
1
star
25

portfolio

My portfolio, built with StaticMatic
JavaScript
1
star
26

node-api-boilerplate

Simple Node.js API server boilerplate using CoffeeScript and Express
CoffeeScript
1
star