OptionalcacheOptionalcatchCatch all errors instead of exit upon one. Please note that render errors won't be reached when parse fails.
OptionaldateDefault date format to use if the date filter doesn't include a format. Defaults to %A, %B %-e, %Y at %-l:%M %P %z.
OptionaldynamicIf set, treat the filepath parameter in {%include filepath %} and {%layout filepath%} as a variable, otherwise as a literal value. Defaults to true.
OptionalextnameAdd a extname (if filepath doesn't include one) before template file lookup. Eg: setting to ".html" will allow including file by basename. Defaults to "".
Optionalfsfs is used to override the default file-system module with a custom implementation.
Optionalglobalsthe global scope passed down to all partial and layout templates, i.e. templates included by include, layout and render tags.
OptionalgreedyWhether trim*Left/trim*Right is greedy. When set to true, all consecutive blank characters including \n will be trimmed regardless of line breaks. Defaults to true.
OptionaljekyllUse jekyll style include, pass parameters to include variable of current scope. Defaults to false.
OptionaljekyllUse jekyll style where filter, enables array item match. Defaults to false.
OptionaljsUse JavaScript Truthiness. Defaults to false.
OptionalkeepWhether or not to keep value type when writing the Output, not working for streamed rendering. Defaults to false.
OptionalkeykeyValue separator
OptionallayoutsA directory or an array of directories from where to resolve layout templates. If it's an array, the files are looked up in the order they occur in the array. Defaults to root
OptionallenientModifies the behavior of strictVariables. If set, a single undefined variable will not cause an exception in the context of the if/elsif/unless tag and the default filter. Instead, it will evaluate to false and null, respectively. Irrelevant if strictVariables is not set. Defaults to false. *
OptionallocaleDefault locale, will be used by date filter. Defaults to system locale.
OptionalmemoryFor DoS handling, limit new objects creation, including array concat/join/strftime, etc. A typical PC can handle 1e9 (1G) memory without issue.
OptionaloperatorsAn object of operators for conditional statements. Defaults to the regular Liquid operators.
OptionalorderedRespect parameter order when using filters like "for ... reversed limit", Defaults to false.
OptionaloutputThe left delimiter for liquid outputs. *
OptionaloutputThe right delimiter for liquid outputs. *
OptionaloutputDefault escape filter applied to output values, when set, you'll have to add | raw for values don't need to be escaped. Defaults to undefined.
OptionalownHide scope variables from prototypes, useful when you're passing a not sanitized object into LiquidJS or need to hide prototypes from templates.
OptionalparseFor DoS handling, limit total length of templates parsed in one parse() call. A typical PC can handle 1e8 (100M) characters without issues.
OptionalpartialsA directory or an array of directories from where to resolve included templates. If it's an array, the files are looked up in the order they occur in the array. Defaults to root
OptionalpreserveWhether input strings to date filter preserve the given timezone *
OptionalrelativeAllow refer to layouts/partials by relative pathname. To avoid arbitrary filesystem read, paths been referenced also need to be within corresponding root, partials, layouts. Defaults to true.
OptionalrenderFor DoS handling, limit total time (in ms) for each render() call.
OptionalrootA directory or an array of directories from where to resolve layout and include templates, and the filename passed to .renderFile(). If it's an array, the files are looked up in the order they occur in the array. Defaults to ["."]
OptionalstrictWhether or not to assert filter existence. If set to false, undefined filters will be skipped. Otherwise, undefined filters will cause an exception. Defaults to false.
OptionalstrictWhether or not to assert variable existence. If set to false, undefined variables will be rendered as empty string. Otherwise, undefined variables will cause an exception. Defaults to false.
OptionaltagThe left delimiter for liquid tags. *
OptionaltagThe right delimiter for liquid tags. *
OptionaltemplatesRender from in-memory templates mapping instead of file system. File system related options like fs, 'root', and relativeReference will be ignored when templates is specified.
OptionaltimezoneJavaScript timezone name or timezoneOffset for date filter, default to local time. That means if you're in Australia (UTC+10), it'll default to -600 or Australia/Lindeman
OptionaltrimSimilar to trimOutputRight, whereas the \n is exclusive. Defaults to false. See Whitespace Control for details.
OptionaltrimStrip blank characters (including , \t, and \r) from the right of values ({{ }}) until \n (inclusive). Defaults to false.
OptionaltrimSimilar to trimTagRight, whereas the \n is exclusive. Defaults to false. See Whitespace Control for details.
OptionaltrimStrip blank characters (including , \t, and \r) from the right of tags ({% %}) until \n (inclusive). Defaults to false.
Whether or not to cache resolved templates. Defaults to
false.