LiquiDoc Liquid Filters Reference

For your convenience, here we present at least basic documentation for the complete set of Liquid. We are committed to building this resource into API docs that cleanly cover the various implementations of Liquid, especially between Jekyll’s implementation for “layouts” and “includes” to generate site HTML, and LiquiDoc’s implementation for prebuilding data into useful new source content.

Array Management Filters

Pop

Key	`pop`
Description	Remove an item from the end of an array

Examples

input

{{ page.tags | pop }}

output

["Seattle"]

Origin	Jekyll
Related	`push`, `shift`, `store_list_concat`, `store_list_dupes`, `unshift`

Push

Key	`push`
Description	Insert an item at the end of an array

Examples

input

{{ page.tags | push: "Spokane" }}

output

["Seattle", "Tacoma", "Spokane"]

Origin	Jekyll
Related	`pop`, `shift`, `store_list_concat`, `store_list_dupes`, `unshift`

Shift

Key	`shift`
Description	Remove an item from the beginning of an array

Examples

input

{{ page.tags | shift }}

output

["Tacoma"]

Origin	Jekyll
Related	`pop`, `push`, `store_list_concat`, `store_list_dupes`, `unshift`

Metastore list concat

Key	`store_list_concat`
Description	Concatenates each Array-formatted value of the same-named property across all nodes in an Array of Hashes (Metastore). Accepts an Array of Hashes and the keyname of a property to collect from.

Examples

input

{{ data.metastore | store_list_concat: "children" }}

Origin	LiquiDoc
Related	`pop`, `push`, `shift`, `store_list_dupes`, `unshift`

Metastore list duplicates

Key	`store_list_dupes`
Description	Returns a list of duplicate items among multiple Arrays across multiple same-named properties in an Array of Hashes (Metastore). Accepts an Array of Hashes and the keyname of a Scalar property to check; returns the names of duplicate properties.

Examples

input

{{ data.metastore | store_list_concat: "children" }}

Origin	LiquiDoc
Related	`pop`, `push`, `shift`, `store_list_concat`, `unshift`

Unshift

Key	`unshift`
Description	Insert an item at the beginning of an array

Examples

input

{{ page.tags | unshift: "Olympia" }}

output

["Olympia", "Seattle", "Tacoma"]

Origin	Jekyll
Related	`pop`, `push`, `shift`, `store_list_concat`, `store_list_dupes`

Array Organizing Filters

Group By

Key	`group_by`
Description	Group an array’s items by a given property.

Examples

input

{{ data.members | group_by:"year" }}

Origin	Jekyll
Related	`group_by_exp`, `reverse`, `sort`

Group By Expression

Key	`group_by_exp`
Description	Group an array’s items using a Liquid expression.

Examples

input

{{ data.members | group_by_exp: "item",
"item.grad_year | truncate: 3, ''" }}

output

[{"name"=>"201", "items"=>[...]},
{"name"=>"200", "items"=>[...]}]

Origin	Jekyll
Related	`group_by`, `reverse`, `sort`

Reverse

Key

reverse

Origin	Shopify
Related	`group_by`, `group_by_exp`, `sort`

Sort

Key	`sort`
Description	Sort an array. Optional arguments for hashes property name nils order (first or last).

Examples

input

{{ page.tags | sort }}

returns

A one-dimensional array, alphabetized

input

{{ site.posts | sort: "author" }}

returns

An array of hashes, alphabetized by the value of the author property

input

{{ site.pages | sort: "title", "last" }}

returns

An array of hashes, alphabetized by the title property’s values, with items lacking titles (nil) at the end

Origin	Jekyll
Related	`group_by`, `group_by_exp`, `reverse`

Array Select Filters

First

Key

first

Origin	Shopify
Related	`last`, `sample`, `where`, `where_exp`

Last

Key

last

Origin	Shopify
Related	`first`, `sample`, `where`, `where_exp`

Sample

Key	`sample`
Description	Pick a random value from an array. Optionally, pick multiple values.

Examples

input

{{ site.pages | sample }}

returns

An array containing one randomly chosen array item.

input

{{ site.pages | sample: 2 }}

returns

An array containing two randomly chosen array items.

Origin	Jekyll
Related	`first`, `last`, `where`, `where_exp`

Where

Key	`where`
Description	Select all the objects in an array where the key has the given value.
Notes	To express a lone result record, use `result_var[0]`.

Examples

input

{{ users | where:"level",2 }}

input

{% assign member = users | where:"user","ava" %} {{ member[0] }}

output

{"user"=>"ava","grad_year"=>2014,"joined"=>"2019-01-22"}

Origin	Jekyll
Related	`first`, `last`, `sample`, `where_exp`

Where Expression

Key	`where_exp`
Description	Select all the objects in an array where the expression is true.

Examples

input

{{ data.members | where_exp:"item",
"item.grad_year < 2014" }}

output

[{"user"=>"ava","grad_year"=>2014},{"user"=>"julia","grad_year"=>2014}]

input

{{ data.members | where_exp:"item",
"item.projects contains 'foo'" }}

output

[{"project"=>"foobar"},{"project"=>"fooman"}]

Origin	Jekyll
Related	`first`, `last`, `sample`, `where`

Date Format Filters

Date to Long String

Key	`date_to_long_string`
Description	Format a date to long format.

Examples

input

{{ data.time | date_to_long_string }}

output

07 November 2008

input

{{ data.time | date_to_long_string: "ordinal" }}

output

7th November 2008

Origin	Jekyll
Related	`date_to_rfc822`, `date_to_string`, `date_to_xml_schema`

Date to RFC-822 Format

Key	`date_to_rfc822`
Description	Convert a Date into the RFC-822 format used for RSS feeds.

Examples

input

{{ data.time | date_to_rfc822 }}

output

Mon, 07 Nov 2008 13:07:54 -0800

Date to String

Key	`date_to_string`
Description	Convert a date to short format.

Examples

input

{{ data.time | date_to_string }}

output

07 Nov 2008

input

{{ data.time | date_to_string: "ordinal", "US" }}

output

Nov 7th, 2008

Origin	Jekyll
Related	`date_to_long_string`, `date_to_rfc822`, `date_to_xml_schema`

Date to XML Schema

Key	`date_to_xml_schema`
Description	Convert a Date into XML Schema (ISO 8601) format.

Examples

input

{{ "2008-11-07 1:07:54pm" | date_to_xmlschema }}

output

2008-11-07T13:07:54-08:00

Origin	Jekyll
Related	`date_to_long_string`, `date_to_rfc822`, `date_to_string`

Math Filters

Absolute Value

Key

abs

Origin	Shopify
Related	`at_least`, `at_most`, `ceil`, `divided_by`, `floor`, `minus`, `modulo`, `plus`, `round`, `times`

At Least

Key	`at_least`

Origin	Shopify
Related	`abs`, `at_most`, `ceil`, `divided_by`, `floor`, `minus`, `modulo`, `plus`, `round`, `times`

At Most

Key

at_most

Origin	Shopify
Related	`abs`, `at_least`, `ceil`, `divided_by`, `floor`, `minus`, `modulo`, `plus`, `round`, `times`

Ceiling

Key

ceil

Origin	Shopify
Related	`abs`, `at_least`, `at_most`, `divided_by`, `floor`, `minus`, `modulo`, `plus`, `round`, `times`

Divided By

Key	`divided_by`

Origin	Shopify
Related	`abs`, `at_least`, `at_most`, `ceil`, `floor`, `minus`, `modulo`, `plus`, `round`, `times`

Floor

Key

floor

Origin	Shopify
Related	`abs`, `at_least`, `at_most`, `ceil`, `divided_by`, `minus`, `modulo`, `plus`, `round`, `times`

Minus (subtract)

Key

minus

Origin	Shopify
Related	`abs`, `at_least`, `at_most`, `ceil`, `divided_by`, `floor`, `modulo`, `plus`, `round`, `times`

Modulo

Key

modulo

Origin	Shopify
Related	`abs`, `at_least`, `at_most`, `ceil`, `divided_by`, `floor`, `minus`, `plus`, `round`, `times`

Plus (add)

Key

plus

Origin	Shopify
Related	`abs`, `at_least`, `at_most`, `ceil`, `divided_by`, `floor`, `minus`, `modulo`, `round`, `times`

Round

Key

round

Origin	Shopify
Related	`abs`, `at_least`, `at_most`, `ceil`, `divided_by`, `floor`, `minus`, `modulo`, `plus`, `times`

Times (multiply)

Key

times

Origin	Shopify
Related	`abs`, `at_least`, `at_most`, `ceil`, `divided_by`, `floor`, `minus`, `modulo`, `plus`, `round`

Object Analysis Filters

Holds Liquid

Key	`holds_liquid`
Description	Returns true if a snippet of text contains Liquid markup tags.

Examples

input

{{ "{% assign var = 'anything' %}" | holds_liquid }}

output

true

Origin	LiquiDoc
Related	`inspect`, `size`

Inspect

Key	`inspect`
Description	Convert an object into its String representation for debugging.

Examples

input

{{ some_var | inspect }}

Origin	Jekyll
Related	`holds_liquid`, `size`

Size

Key

size

Origin	Shopify
Related	`holds_liquid`, `inspect`

Object Conversion Filters

Array to Sentence

Key	`array_to_sentence_string`
Description	Convert an array into a sentence. Useful for listing tags. Optional argument for connector.

Examples

input

{{ tags_array | array_to_sentence_string }}

output

foo, bar, and baz

input

{{ tags_array | array_to_sentence_string: "or" }}

output

foo, bar, or baz

Origin	Jekyll
Related	`array_to_serial`, `join`, `jsonify`, `map`, `slice`, `to_cli_args`, `to_integer`, `to_json`, `to_yaml`

Array to Serial

Key	`array_to_serial`
Description	Convert an array into a sentence. Useful for listing tags. Optional argument for connector.

Examples

input

{{ tags_array | array_to_serial }}

output

foo, bar, and baz

input

{{ tags_array | array_to_serial: "or" }}

output

foo, bar, or baz

input

{{ tags_array | shift | array_to_serial: "or" }}

output

foo or baz

Origin	Jekyll
Related	`array_to_sentence_string`, `join`, `jsonify`, `map`, `slice`, `to_cli_args`, `to_integer`, `to_json`, `to_yaml`

Join

Key

join

Origin	Shopify
Related	`array_to_sentence_string`, `array_to_serial`, `jsonify`, `map`, `slice`, `to_cli_args`, `to_integer`, `to_json`, `to_yaml`

Data To JSON

Key	`jsonify`
Description	Convert Hash or Array to JSON.

Examples

input

{{ data.projects | jsonify }}

output

<JSON object>

Origin	Jekyll
Related	`array_to_sentence_string`, `array_to_serial`, `join`, `map`, `slice`, `to_cli_args`, `to_integer`, `to_json`, `to_yaml`

Map

Key

map

Origin	Shopify
Related	`array_to_sentence_string`, `array_to_serial`, `join`, `jsonify`, `slice`, `to_cli_args`, `to_integer`, `to_json`, `to_yaml`

Slice

Key

slice

Origin	Shopify
Related	`array_to_sentence_string`, `array_to_serial`, `join`, `jsonify`, `map`, `to_cli_args`, `to_integer`, `to_json`, `to_yaml`

Hash Params to CLI Arguments

Key	`to_cli_args`
Description	Turn a Hash/Struct of key-value pairs into a string of CLI-formatted arguments. Accepts two arguments: a template and a delimeter. The first optional position is either the name of a stored Liquid template or an actual string of Liquid to match. Stored templates include:
hyph	`-<key> <value>`
hyphhyph	`--<key> <value>` (default)
dump	`<key> <value>`
paramequal	`<key>=<value>`
valonly	`<value>`

Second optional position is a delimeter.

Examples

input

{{ my_flat_hash | to_cli_args }}

output

--key1 valuu_one --key2 val_two --key3 'third value'

input

{{ my_flat_hash | to_cli_args: 'paramequal' }}

output

--key1 'valuu_one' --key2 'val_two' --key3 'third value'

input

{% capture argpattern %}{% raw %}{{opt}} {{arg | quote_wrap: '[]'}}{% endraw %}{% endcapture %}
{{ object | to_cli_args: argpattern, " | " }}

output

key1 [val 1] | key2 val2 | key3 | key4 [val four]

Origin	LiquiDoc
Related	`array_to_sentence_string`, `array_to_serial`, `join`, `jsonify`, `map`, `slice`, `to_integer`, `to_json`, `to_yaml`

To Integer

Key	`to_integer`
Description	Convert a string or boolean to integer.

Examples

input

{{ true | to_integer }}

output

input

{% assign five = "5" | to_integer %}
{% if five == 5 %}Samesies!{% endif %}

output

Samesies!

input

{{ "five" | to_integer }}

output

Origin	Jekyll
Related	`array_to_sentence_string`, `array_to_serial`, `join`, `jsonify`, `map`, `slice`, `to_cli_args`, `to_json`, `to_yaml`

Data objects to JSON

Key	`to_json`
Description	Turn any parameter or data object into JSON format.

Origin	LiquiDoc
Related	`array_to_sentence_string`, `array_to_serial`, `join`, `jsonify`, `map`, `slice`, `to_cli_args`, `to_integer`, `to_yaml`

Data objects to YAML

Key	`to_yaml`
Description	Turn any parameter or data object into YAML format.

Origin	LiquiDoc
Related	`array_to_sentence_string`, `array_to_serial`, `join`, `jsonify`, `map`, `slice`, `to_cli_args`, `to_integer`, `to_json`

String Analysis Filters

Pattern Match

Key	`match`
Description	Returns of string or number matches pattern.

Examples

input

{% assign matched = "testword" | match: "^.*word$" %} {% if matched %}It matched!{% endif %}

output

It matched!

Origin	LiquiDoc
Related	`number_of_words`

Number of Words

Key	`number_of_words`
Description	Count the number of words in a text.

Examples

input

{{ page.content | number_of_words }}

output

Origin	Jekyll
Related	`match`

String Conversion Filters

Capitalize

Key	`capitalize`

Origin	Shopify
Related	`commentwrap`, `downcase`, `escape`, `escape_once`, `newline_to_br`, `normalize_whitespace`, `remove`, `remove_first`, `replace`, `replace_first`, `rstrip`, `slugify`, `smart_format`, `strip`, `strip_html`, `strip_newlines`, `strip_tags`, `titlecase`, `to_slug`, `truncatewords`, `upcase`, `wrap`

Comment Wrap

Key	`commentwrap`

Examples

input

{{ comment_text | commentwrap: 25, "// " }}

output

// A string that is obviously longer
// than 25 characters

Origin	LiquiDoc
Related	`capitalize`, `downcase`, `escape`, `escape_once`, `newline_to_br`, `normalize_whitespace`, `remove`, `remove_first`, `replace`, `replace_first`, `rstrip`, `slugify`, `smart_format`, `strip`, `strip_html`, `strip_newlines`, `strip_tags`, `titlecase`, `to_slug`, `truncatewords`, `upcase`, `wrap`

Downcase

Key	`downcase`

Origin	Shopify
Related	`capitalize`, `commentwrap`, `escape`, `escape_once`, `newline_to_br`, `normalize_whitespace`, `remove`, `remove_first`, `replace`, `replace_first`, `rstrip`, `slugify`, `smart_format`, `strip`, `strip_html`, `strip_newlines`, `strip_tags`, `titlecase`, `to_slug`, `truncatewords`, `upcase`, `wrap`

Escape

Key

escape

Origin	Shopify
Related	`capitalize`, `commentwrap`, `downcase`, `escape_once`, `newline_to_br`, `normalize_whitespace`, `remove`, `remove_first`, `replace`, `replace_first`, `rstrip`, `slugify`, `smart_format`, `strip`, `strip_html`, `strip_newlines`, `strip_tags`, `titlecase`, `to_slug`, `truncatewords`, `upcase`, `wrap`

Escape Once

Key	`escape_once`

Origin	Shopify
Related	`capitalize`, `commentwrap`, `downcase`, `escape`, `newline_to_br`, `normalize_whitespace`, `remove`, `remove_first`, `replace`, `replace_first`, `rstrip`, `slugify`, `smart_format`, `strip`, `strip_html`, `strip_newlines`, `strip_tags`, `titlecase`, `to_slug`, `truncatewords`, `upcase`, `wrap`

Newline to Break Tag

Key	`newline_to_br`

Origin	Shopify
Related	`capitalize`, `commentwrap`, `downcase`, `escape`, `escape_once`, `normalize_whitespace`, `remove`, `remove_first`, `replace`, `replace_first`, `rstrip`, `slugify`, `smart_format`, `strip`, `strip_html`, `strip_newlines`, `strip_tags`, `titlecase`, `to_slug`, `truncatewords`, `upcase`, `wrap`

Normalize Whitespace

Key	`normalize_whitespace`
Description	Replace any occurrence of whitespace with a single space.

Examples

input

{{ "a    b" | normalize_whitespace }}

output

a b

Origin	Jekyll
Related	`capitalize`, `commentwrap`, `downcase`, `escape`, `escape_once`, `newline_to_br`, `remove`, `remove_first`, `replace`, `replace_first`, `rstrip`, `slugify`, `smart_format`, `strip`, `strip_html`, `strip_newlines`, `strip_tags`, `titlecase`, `to_slug`, `truncatewords`, `upcase`, `wrap`

Remove

Key

remove

Origin	Shopify
Related	`capitalize`, `commentwrap`, `downcase`, `escape`, `escape_once`, `newline_to_br`, `normalize_whitespace`, `remove_first`, `replace`, `replace_first`, `rstrip`, `slugify`, `smart_format`, `strip`, `strip_html`, `strip_newlines`, `strip_tags`, `titlecase`, `to_slug`, `truncatewords`, `upcase`, `wrap`

Remove First

Key	`remove_first`

Origin	Shopify
Related	`capitalize`, `commentwrap`, `downcase`, `escape`, `escape_once`, `newline_to_br`, `normalize_whitespace`, `remove`, `replace`, `replace_first`, `rstrip`, `slugify`, `smart_format`, `strip`, `strip_html`, `strip_newlines`, `strip_tags`, `titlecase`, `to_slug`, `truncatewords`, `upcase`, `wrap`

Replace

Key

replace

Origin	Shopify
Related	`capitalize`, `commentwrap`, `downcase`, `escape`, `escape_once`, `newline_to_br`, `normalize_whitespace`, `remove`, `remove_first`, `replace_first`, `rstrip`, `slugify`, `smart_format`, `strip`, `strip_html`, `strip_newlines`, `strip_tags`, `titlecase`, `to_slug`, `truncatewords`, `upcase`, `wrap`

Replace First

Key	`replace_first`

Origin	Shopify
Related	`capitalize`, `commentwrap`, `downcase`, `escape`, `escape_once`, `newline_to_br`, `normalize_whitespace`, `remove`, `remove_first`, `replace`, `rstrip`, `slugify`, `smart_format`, `strip`, `strip_html`, `strip_newlines`, `strip_tags`, `titlecase`, `to_slug`, `truncatewords`, `upcase`, `wrap`

Right Strip

Key

rstrip

Origin	Shopify
Related	`capitalize`, `commentwrap`, `downcase`, `escape`, `escape_once`, `newline_to_br`, `normalize_whitespace`, `remove`, `remove_first`, `replace`, `replace_first`, `slugify`, `smart_format`, `strip`, `strip_html`, `strip_newlines`, `strip_tags`, `titlecase`, `to_slug`, `truncatewords`, `upcase`, `wrap`

Slugify

Key

slugify

Description

Convert a string into a lowercase URL "slug".

This is not the Jekyll version.

Examples

input

{{ "The _config.yml file" | slugify }}

output

the-config-yml-file

input

{{ "The _config.yml file" | slugify: "_" }}

output

the_config_yml_file

Origin	LiquiDoc
Related	`capitalize`, `commentwrap`, `downcase`, `escape`, `escape_once`, `newline_to_br`, `normalize_whitespace`, `remove`, `remove_first`, `replace`, `replace_first`, `rstrip`, `smart_format`, `strip`, `strip_html`, `strip_newlines`, `strip_tags`, `titlecase`, `to_slug`, `truncatewords`, `upcase`, `wrap`

Smart Format

Key	`smart_format`
Description	Convert UTF-8 or HTML-tagged text to “curly” quotes, emdashes, copyright, trademark, etc.

Examples

input

{% capture statement %}“He said, ‘Away, Drake!’”{% endcapture %}
{{ statement | smart_format }}

output

“He said, ‘Away, Drake!’”

input

{% capture statement %}"He said, <b>'Away, Drake!'</b>"{% endcapture %}
{{ statement | smart_format }}

output

“He said, ‘Away, Drake!’”

Origin	sterile gem
Related	`capitalize`, `commentwrap`, `downcase`, `escape`, `escape_once`, `newline_to_br`, `normalize_whitespace`, `remove`, `remove_first`, `replace`, `replace_first`, `rstrip`, `slugify`, `strip`, `strip_html`, `strip_newlines`, `strip_tags`, `titlecase`, `to_slug`, `truncatewords`, `upcase`, `wrap`

Strip

Key

strip

Origin	Shopify
Related	`capitalize`, `commentwrap`, `downcase`, `escape`, `escape_once`, `newline_to_br`, `normalize_whitespace`, `remove`, `remove_first`, `replace`, `replace_first`, `rstrip`, `slugify`, `smart_format`, `strip_html`, `strip_newlines`, `strip_tags`, `titlecase`, `to_slug`, `truncatewords`, `upcase`, `wrap`

Strip HTML

Key	`strip_html`

Origin	Shopify
Related	`capitalize`, `commentwrap`, `downcase`, `escape`, `escape_once`, `newline_to_br`, `normalize_whitespace`, `remove`, `remove_first`, `replace`, `replace_first`, `rstrip`, `slugify`, `smart_format`, `strip`, `strip_newlines`, `strip_tags`, `titlecase`, `to_slug`, `truncatewords`, `upcase`, `wrap`

Strip Newlines

Key	`strip_newlines`

Origin	Shopify
Related	`capitalize`, `commentwrap`, `downcase`, `escape`, `escape_once`, `newline_to_br`, `normalize_whitespace`, `remove`, `remove_first`, `replace`, `replace_first`, `rstrip`, `slugify`, `smart_format`, `strip`, `strip_html`, `strip_tags`, `titlecase`, `to_slug`, `truncatewords`, `upcase`, `wrap`

Strip Tags

Key	`strip_tags`
Description	Remove HTML/XML tags from text. Also strips out comments, PHP and ERB style tags.

Examples

input

{{ 'Visit our <a href="http://example.com">website!</a>' | strip_tags }}

output

Visit our website!

Origin	sterile gem
Related	`capitalize`, `commentwrap`, `downcase`, `escape`, `escape_once`, `newline_to_br`, `normalize_whitespace`, `remove`, `remove_first`, `replace`, `replace_first`, `rstrip`, `slugify`, `smart_format`, `strip`, `strip_html`, `strip_newlines`, `titlecase`, `to_slug`, `truncatewords`, `upcase`, `wrap`

Titlecase

Key	`titlecase`
Description	Format text appropriately for titles.

Examples

input

{{ "Q&A with Steve Jobs: 'That's what happens in technology'" || titlecase }}

output

Q&A With Steve Jobs: 'That's What Happens in Technology'

Origin	sterile gem
Related	`capitalize`, `commentwrap`, `downcase`, `escape`, `escape_once`, `newline_to_br`, `normalize_whitespace`, `remove`, `remove_first`, `replace`, `replace_first`, `rstrip`, `slugify`, `smart_format`, `strip`, `strip_html`, `strip_newlines`, `strip_tags`, `to_slug`, `truncatewords`, `upcase`, `wrap`

String to Slug

Key	`to_slug`
Description	Simple slug converter.

Origin	sterile gem
Related	`capitalize`, `commentwrap`, `downcase`, `escape`, `escape_once`, `newline_to_br`, `normalize_whitespace`, `remove`, `remove_first`, `replace`, `replace_first`, `rstrip`, `slugify`, `smart_format`, `strip`, `strip_html`, `strip_newlines`, `strip_tags`, `titlecase`, `truncatewords`, `upcase`, `wrap`

Truncate Words

Key	`truncatewords`

Origin	Shopify
Related	`capitalize`, `commentwrap`, `downcase`, `escape`, `escape_once`, `newline_to_br`, `normalize_whitespace`, `remove`, `remove_first`, `replace`, `replace_first`, `rstrip`, `slugify`, `smart_format`, `strip`, `strip_html`, `strip_newlines`, `strip_tags`, `titlecase`, `to_slug`, `upcase`, `wrap`

Upcase

Key

upcase

Origin	Shopify
Related	`capitalize`, `commentwrap`, `downcase`, `escape`, `escape_once`, `newline_to_br`, `normalize_whitespace`, `remove`, `remove_first`, `replace`, `replace_first`, `rstrip`, `slugify`, `smart_format`, `strip`, `strip_html`, `strip_newlines`, `strip_tags`, `titlecase`, `to_slug`, `truncatewords`, `wrap`

Wrap

Key

wrap

Examples

input

{{ "A string that is obviously longer than 25 characters" | wrap: 25 }}

output

A string that is obviously longer
than 25 characters

Origin	LiquiDoc
Related	`capitalize`, `commentwrap`, `downcase`, `escape`, `escape_once`, `newline_to_br`, `normalize_whitespace`, `remove`, `remove_first`, `replace`, `replace_first`, `rstrip`, `slugify`, `smart_format`, `strip`, `strip_html`, `strip_newlines`, `strip_tags`, `titlecase`, `to_slug`, `truncatewords`, `upcase`

String Escape Filters

CGI Escape

Key	`cgi_escape`
Description	CGI escape a string for use in a URL. Replaces any special characters with appropriate `%XX` replacements. CGI escape normally replaces a space with a plus `+` sign.

Examples

input

{{ "foo, bar; baz?" | cgi_escape }}

output

foo%2C+bar%3B+baz%3F

Origin	Jekyll
Related	`uri_escape`, `xml_escape`

URI Escape

Key	`uri_escape`
Description	Percent encodes any special characters in a URI. URI escape normally replaces a space with `%20`. Reserved characters will not be escaped.

Examples

input

{{ "http://foo.com/?q=foo, \bar?" | uri_escape }}

output

http://foo.com/?q=foo,%20%5Cbar?

Origin	Jekyll
Related	`cgi_escape`, `xml_escape`

XML Escape

Key	`xml_escape`
Description	Escape some text for use in XML.

Examples

input

{{ "<strong>some text</strong>" | xml_escape }}

output

&lt;strong&gt;some text&lt;/strong&gt;

Origin	Jekyll
Related	`cgi_escape`, `uri_escape`

String Management Filters

Append

Key

append

Origin	Shopify
Related	`lstrip`, `prepend`, `regexreplace`, `replace_regex`, `truncate`

Left Strip

Key

lstrip

Origin	Shopify
Related	`append`, `prepend`, `regexreplace`, `replace_regex`, `truncate`

Prepend

Key

prepend

Origin	Shopify
Related	`append`, `lstrip`, `regexreplace`, `replace_regex`, `truncate`

Regular Expression Replace

Key	`regexreplace`
Description	Use regular expressions to match and replace text patterns.

Examples

input

{{ "name=content" | regexreplace: "^\=|\s$", ": " }}

output

name: content

input

{{ "name=content" | regexreplace: "([\w]+):\s([\w]+)", "\1=\2" }}

output

key=content

Origin	LiquiDoc
Related	`append`, `lstrip`, `prepend`, `replace_regex`, `truncate`

Regular Expression Replace

Key	`replace_regex`
Description	Use regular expressions to match and replace text patterns.

Examples

input

{{ "name=content" | replace_regex: "^\=|\s$", ": " }}

output

name: content

input

{{ "name=content" | replace_regex: "([\w]+):\s([\w]+)", "\1=\2" }}

output

key=content

Origin	LiquiDoc
Related	`append`, `lstrip`, `prepend`, `regexreplace`, `truncate`

Truncate

Key	`truncate`

Origin	Shopify
Related	`append`, `lstrip`, `prepend`, `regexreplace`, `replace_regex`

String Recode Filters

Decode Entities

Key	`decode_entities`
Description	Turn HTML entities into Unicode characters.

Examples

input

{{ "&ldquo;Economy Hits Bottom,&rdquo; ran the headline" | decode_entities }}

output

“Economy Hits Bottom,” ran the headline

Origin	sterile gem
Related	`encode_entities`, `sterilize`, `transliterate`, `url_decode`, `url_encode`

Encode Entities

Key	`encode_entities`
Description	Turn Unicode characters into their HTML equivilents.

Examples

input

{{ "“Economy Hits Bottom,” ran the headline" | encode_entities }}

output

&ldquo;Economy Hits Bottom,&rdquo; ran the headline

Origin	sterile gem
Related	`decode_entities`, `sterilize`, `transliterate`, `url_decode`, `url_encode`

Sterilize

Key	`sterilize`
Description	Transliterate to ASCII and strip out any HTML/XML tags.

Examples

input

{{ "<b>nåsty</b>" | sterilize }}

output

nasty

Origin	sterile gem
Related	`decode_entities`, `encode_entities`, `transliterate`, `url_decode`, `url_encode`

Transliterate to ASCII

Key	`transliterate`
Description	Convert Unicode [and accented ASCII] characters to their plain-text ASCII equivalents.

Examples

input

{{ "šţɽĩɳģ" | transliterate }}

output

string

Origin	sterile gem
Related	`decode_entities`, `encode_entities`, `sterilize`, `url_decode`, `url_encode`

URL Decode

Key	`url_decode`

Origin	Shopify
Related	`decode_entities`, `encode_entities`, `sterilize`, `transliterate`, `url_encode`

URL Encode

Key	`url_encode`

Origin	Shopify
Related	`decode_entities`, `encode_entities`, `sterilize`, `transliterate`, `url_decode`