Skip to content
A complete Liquid template engine in Go
Branch: master
Clone or download
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github Update guidelines to refer to issues board Jul 9, 2017
cmd/liquid Coverage Jul 19, 2017
evaluator Package docs Aug 8, 2017
expressions Package docs Aug 8, 2017
render Default time format is compatible w/ Liquid Aug 18, 2017
scripts CLI script to run shopify liquid for cf. Jul 16, 2017
tags Define IterationKeyedMap Aug 15, 2017
.all-contributorsrc Add Contributors section; add nsf as contributor; adopt All Contribut… May 30, 2018
.appveyor.yml Appveyor: remove mingw Aug 8, 2017
.gitignore gitgnore *.test Jul 22, 2017
.travis.yml Add make pre-commit; lint before testing Jun 5, 2018 Add latest PR to CHANGELOG Jun 5, 2018 Add make pre-commit; lint before testing Jun 5, 2018
LICENSE Create LICENSE Jun 26, 2017
Makefile Add make pre-commit; lint before testing Jun 5, 2018 Re-organize README Jun 5, 2018
drops.go Add FromDrop func Jul 11, 2017
drops_test.go More drop examples Aug 8, 2017
engine.go Merge pull request #26 from Proximaio/feature/customise_delimiters Jul 27, 2017
engine_examples_test.go More drop examples Aug 8, 2017
engine_test.go Tests Jul 26, 2017
liquid.go Define IterationKeyedMap Aug 15, 2017
liquid_test.go Define IterationKeyedMap Aug 15, 2017
template.go Source location is an initialization parameter Jul 14, 2017

Liquid Template Parser

liquid is a pure Go implementation of Shopify Liquid templates. It was developed for use in the Gojekyll port of the Jekyll static site generator.


go get # latest snapshot

go get -u # development version


engine := liquid.NewEngine()
template := `<h1>{{ page.title }}</h1>`
bindings := map[string]interface{}{
    "page": map[string]string{
        "title": "Introduction",
out, err := engine.ParseAndRenderString(template, bindings)
if err != nil { log.Fatalln(err) }
// Output: <h1>Introduction</h1>

See the API documentation for additional examples.

Command-Line tool

go install installs a command-line liquid executable. This is intended to make it easier to create test cases for bug reports.

$ liquid --help
usage: liquid [FILE]
$ echo '{{ "Hello World" | downcase | split: " " | first | append: "!"}}' | liquid



These features of Shopify Liquid aren't implemented:

  • Warn and lax error modes.
  • Non-strict filters. An undefined filter is currently an error.
  • Strict variables. An undefined variable is not an error.


Drops have a different design from the Shopify (Ruby) implementation. A Ruby drop sets liquid_attributes to a list of attributes that are exposed to Liquid. A Go drop implements ToLiquid() interface{}, that returns a proxy object. Conventionally, the proxy is a map or struct that defines the exposed properties. See for additional information.

Value Types

Render and friends take a Bindings parameter. This is a map of string to interface{}, that associates template variable names with Go values.

Any Go value can be used as a variable value. These values have special meaning:

  • false and nil
    • These, and no other values, are recognized as false by and, or, {% if %}, {% elsif %}, and {% case %}.
  • Integers
    • (Only) integers can be used as array indices: array[1]; array[n], where array has an array value and n has an integer value.
    • (Only) integers can be used as the endpoints of a range: {% for item in (1..5) %}, {% for item in (start..end) %} where start and end have integer values.
  • Integers and floats
    • Integers and floats are converted to their join type for comparison: 1 == 1.0 evaluates to true. Similarly, int8(1), int16(1), uint8(1) etc. are all ==.
    • [There is currently no special treatment of complex numbers.]
  • Integers, floats, and strings
    • Integers, floats, and strings can be used in comparisons <, >, <=, >=. Integers and floats can be usefully compared with each other. Strings can be usefully compared with each other, but not with other values. Any other comparison, e.g. 1 < "one", 1 > "one", is always false.
  • Arrays (and slices)
    • An array can be indexed by integer value: array[1]; array[n] where n has an integer value.
    • Arrays have first, last, and size properties: array.first == array[0], array[array.size-1] == array.last (where array.size > 0)
  • Maps
    • A map can be indexed by a string: hash["key"]; hash[s] where s has a string value
    • A map can be accessed using property syntax hash.key
    • Maps have a special size property, that returns the size of the map.
  • Drops
    • A value value of a type that implements the Drop interface acts as the value value.ToLiquid(). There is no guarantee about how many times ToLiquid will be called. [This is in contrast to Shopify Liquid, which both uses a different interface for drops, and makes stronger guarantees.]
  • Structs
    • A public field of a struct can be accessed by its name: value.FieldName, value["fieldName"].
      • A field tagged e.g. liquid:”name” is accessed as instead.
      • If the value of the field is a function that takes no arguments and returns either one or two arguments, accessing it invokes the function, and the value of the property is its first return value.
      • If the second return value is non-nil, accessing the field panics instead.
    • A function defined on a struct can be accessed by function name e.g. value.Func, value["Func"].
      • The same rules apply as to accessing a func-valued public field.
    • Note that despite being array- and map-like, structs do not have a special value.size property.
  • []byte
    • A value of type []byte is rendered as the corresponding string, and presented as a string to filters that expect one. A []byte is not (currently) equivalent to a string for all uses; for example, a < b, a contains b, hash[b] will not behave as expected where a or b is a []byte.
  • MapSlice
    • An instance of yaml.MapSlice acts as a map. It implements m.key, m[key], and m.size.



Bug reports, test cases, and code contributions are more than welcome. Please refer to the contribution guidelines.


Thanks goes to these wonderful people (emoji key):

Oliver Steele

💻 📖 🤔 🚇 👀 ⚠️

James Littlejohn

💻 📖 ⚠️


💻 ⚠️

This project follows the all-contributors specification. Contributions of any kind welcome!


Package Author Description License
Ragel Adrian Thurston scanning expressions MIT Canonical MapSlice Apache License 2.0

Michael Hamrah's Lexing with Ragel and Parsing with Yacc using Go was essential to understanding go yacc.

The original Liquid engine, of course, for the design and documentation of the Liquid template language. Many of the tag and filter test cases are taken directly from the Liquid documentation.

Other Implementations


Other Languages

See Shopify's ports of Liquid to other environments.


MIT License

You can’t perform that action at this time.