public
Rubygem
Description: Liquid markup language. Save, customer facing template language for flexible web apps.
Homepage: http://www.liquidmarkup.org
Clone URL: git://github.com/tobi/liquid.git
Click here to lend your support to: liquid and make a donation at www.pledgie.com !
Tobias Lütke (author)
Thu May 08 08:34:43 -0700 2008
commit  7f58cbf82d9a064c191a1e5ca957f1850bbed5fb
tree    6c39a65f75568213a2c5ca9f17553b62e429730d
parent  1d647361e1a39ee09f1bd2d62701925c0128c578
liquid / README.txt
100644 38 lines (28 sloc) 1.611 kb
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
= Liquid template engine
 
Liquid is a template engine which I wrote for very specific requirements
 
* It has to have beautiful and simple markup.
  Template engines which don't produce good looking markup are no fun to use.
* It needs to be non evaling and secure. Liquid templates are made so that users can edit them. You don't want to run code on your server which your users wrote.
* It has to be stateless. Compile and render steps have to be seperate so that the expensive parsing and compiling can be done once and later on you can
  just render it passing in a hash with local variables and objects.
 
== Why should i use Liquid
 
* You want to allow your users to edit the appearance of your application but don't want them to run insecure code on your server.
* You want to render templates directly from the database
* You like smarty style template engines
* You need a template engine which does HTML just as well as Emails
* You don't like the markup of your current one
 
== What does it look like?
 
  <ul id="products">
   {% for product in products %}
   <li>
   <h2>{{product.name}}</h2>
   Only {{product.price | price }}
  
   {{product.description | prettyprint | paragraph }}
    </li>
   {% endfor %}
  </ul>
 
== Howto use Liquid
 
Liquid supports a very simple API based around the Liquid::Template class.
For standard use you can just pass it the content of a file and call render with a parameters hash.
 
  @template = Liquid::Template.parse("hi {{name}}") # Parses and compiles the template
  @template.render( 'name' => 'tobi' ) # => "hi tobi"