slang~toddsundsted

Slim-inspired templating language for Crystal slang kilt template-language

Help categorize this shard!

1.0.0 released almost 9 years ago

toddsundsted/slang

8 months ago

Todd Sundsted

Source

Slang

Lightweight, terse, templating language for Crystal.

Installation

Add this to your application's shard.yml:

dependencies:
  slang:
    github: jeromegn/slang

Usage

Preferred: use Kilt

Kilt is included as a dependency for this project. It should help integrating non-ECR template engines.

require "kilt"
require "slang"

Kilt.render("path/to/file.slang") #=> <compiled template>

Example with Kemal (includes Kilt):

require "slang"

get "/" do
  render "path/to/file.slang"
end

Without Kilt

String.build do |str|
  Slang.embed("path/to/file.slang", "str")
end

Syntax

doctype html
html
  head
    title This is a title
  body
    span#some-id.classname
      #hello.world.world2
        - some_var = "hello world haha"
        span
          span data-some-var=some_var two-attr="fun" and a #{p("hello")}
          span
            span.deep_nested
              = Process.pid
              | text node
              ' other text node
        span.alongside pid=Process.pid
          custom-tag#with-id pid="#{Process.pid}"
            - ["ah", "oh"].each do |s|
              span = s

    #amazing-div some-attr="hello"

Given the context:

some_var = "hello"
strings = ["ah", "oh"]

Compiles to HTML:

<!DOCTYPE html>
<html>
  <head>
    <title>This is a title</title>
  </head>
  <body>
    <span id="some-id" class="classname">
      <div id="hello" class="world world2">
        <span>
          <span data-some-var="hello world haha" two-attr="fun">and a hello</span>
          <span>
            <span class="deep_nested">
              #{Process.pid}
              text node
              other text node 
            </span>
          </span>
        </span>
        <span class="alongside" pid="#{Process.pid}">
          <custom-tag id="with-id" pid="#{Process.pid}">
            <span>ah</span>
            <span>oh</span>
          </custom-tag>
        </span>
      </div>
    </span>
    <div id="amazing-div" some-attr="hello"></div>
  </body>
</html>

TODO

[ ] More tests
[ ] Website
[ ] Documentation
[x] No need to rely on ECR probably, but that's optimization at this point

Contributing

Fork it ( https://github.com/jeromegn/slang/fork )
Create your feature branch (git checkout -b my-new-feature)
Commit your changes (git commit -am 'Add some feature')
Push to the branch (git push origin my-new-feature)
Create a new Pull Request

Contributors

jeromegn Jerome Gravel-Niquet - creator, maintainer

slang:
  github: toddsundsted/slang
  version: ~> 1.0.0

License MIT

Crystal none

Authors

Jerome Gravel-Niquet jeromegn@gmail.com

Dependencies 1

kilt
```
{'github' => 'jeromegn/kilt'}
```

Development Dependencies 0

Dependents 1

ktistec

Similar shards

slang jeromegn/slang

Releases

Show all 24 releases

Last synced about 17 hours ago.