cmd/liquid | ||
evaluator | ||
expression | ||
filters | ||
render | ||
scripts | ||
tags | ||
.gitignore | ||
.travis.yml | ||
CONTRIBUTING.md | ||
drops.go | ||
engine_test.go | ||
engine.go | ||
LICENSE | ||
liquid.go | ||
Makefile | ||
README.md | ||
template_test.go | ||
template.go | ||
test.html |
Go Liquid Template Parser
“Any sufficiently complicated C or Fortran program contains an ad-hoc, informally-specified, bug-ridden, slow implementation of half of Common Lisp.” – Philip Greenspun
liquid
ports Shopify Liquid templates to Go. It was developed for use in gojekyll.
liquid
provides a functional API for defining tags and filters. See examples here, here, and here.
Status
This library is in early development. The API may still change.
- Basics
- Literals
- String Escapes
- Variables
- Operators
- Arrays
- Whitespace Control
- Literals
- Tags
- Comment
- Control Flow
if
/else
/elsif
unless
case
when
else
- Iteration
- modifiers (
limit
,reversed
,offset
) - range
break
,continue
- loop variables
tablerow
cycle
- modifiers (
- Include
- Raw
- Variables
- Assign
- Capture
- Filters
sort_natural
,uniq
,escape
,truncatewords
,url_decode
,url_encode
- everything else
- Drops
Install
go get -u github.com/osteele/goliquid
make install
install a command-line liquid
program in your GO bin.
This is intended to make it easier to create test cases for bug reports.
Run liquid --help
for help.
Contributing
Bug reports, test cases, and code contributions are more than welcome. Please refer to the contribution guidelines.
References
- Shopify.github.io/liquid
- Liquid for Designers
- Liquid for Programmers
- Help.shopify.com goes into more detail, but includes features that aren't present in core Liquid as used by Jekyll.
Attribution
Package | Author | Description | License |
---|---|---|---|
gopkg.in/yaml.v2 | Canonical | YAML support (for printing parse trees) | Apache License 2.0 |
jeffjen/datefmt | Jeffrey Jen | Go bindings to GNU strftime and strptime |
MIT |
Ragel | Adrian Thurston | scanning expressions | MIT |
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
Go
- karlseguin/liquid is a dormant implementation that inspired a lot of forks.
- acstech/liquid is a more active fork of Karl Seguin's implementation.
- hownowstephen/go-liquid
Other Languages
See Shopify's ports of Liquid to other environments.
License
MIT License