Path: | README.md |
Last Update: | Fri Nov 11 00:26:20 +0000 2016 |
[](http://travis-ci.org/Shopify/liquid) [](http://inch-ci.org/github/Shopify/liquid)
# Liquid template engine
## Introduction
Liquid is a template engine which was written with very specific requirements:
## Why you should use Liquid
## What does it look like?
```html <ul id="products">
{% for product in products %} <li> <h2>{{ product.name }}</h2> Only {{ product.price | price }} {{ product.description | prettyprint | paragraph }} </li> {% endfor %}
</ul> ```
## How to 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.
```ruby @template = Liquid::Template.parse("hi {{name}}") # Parses and compiles the template @template.render(‘name’ => ‘tobi’) # => "hi tobi" ```
### Error Modes
Setting the error mode of Liquid lets you specify how strictly you want your templates to be interpreted. Normally the parser is very lax and will accept almost anything without error. Unfortunately this can make it very hard to debug and can lead to unexpected behaviour.
Liquid also comes with a stricter parser that can be used when editing templates to give better error messages when templates are invalid. You can enable this new parser like this:
```ruby Liquid::Template.error_mode = :strict # Raises a SyntaxError when invalid syntax is used Liquid::Template.error_mode = :warn # Adds errors to template.errors but continues as normal Liquid::Template.error_mode = :lax # The default mode, accepts almost anything. ```
If you want to set the error mode only on specific templates you can pass `:error_mode` as an option to `parse`: ```ruby Liquid::Template.parse(source, :error_mode => :strict) ``` This is useful for doing things like enabling strict mode only in the theme editor.
It is recommended that you enable `:strict` or `:warn` mode on new apps to stop invalid templates from being created. It is also recommended that you use it in the template editors of existing apps to give editors better error messages.