# Liquid Extensions

https://github.com/mojombo/jekyll/wiki/Liquid-Extensions

Jekyll uses Liquid to process templates. Along with the standard liquid tags and filters, Jekyll adds a few of its own:

## Filters

### Date to XML Schema

Convert a Time into XML Schema format.

{{ site.time | date_to_xmlschema }} => 2008-11-17T13:07:54-08:00


### Date to String

Convert a date in short format, e.g. “27 Jan 2011”.

{{ site.time | date_to_string }} => 17 Nov 2008


### Date to Long String

Format a date in long format e.g. “27 January 2011”.

{{ site.time | date_to_long_string }} => 17 November 2008


### XML Escape

Escape some text for use in XML.

{{ page.content | xml_escape }}


### CGI Escape

CGI escape a string for use in a URL. Replaces any special characters with appropriate %XX replacements.

{{ "foo,bar;baz?" | cgi_escape }} => foo%2Cbar%3Bbaz%3F


### Number of Words

Count the number of words in some text.

{{ page.content | number_of_words }} => 1337


### Array to Sentence

Convert an array into a sentence.

{{ page.tags | array_to_sentence_string }} => foo, bar, and baz


### Textilize

Convert a Textile-formatted string into HTML, formatted via RedCloth

{{ page.excerpt | textilize }}


### Markdownify

Convert a Markdown-formatted string into HTML.

{{ page.excerpt | markdownify }}


## Tags

### Include

If you have small page fragments that you wish to include in multiple places on your site, you can use the include tag.

{% include sig.textile %}


Jekyll expects all include files to be placed in an _includes directory at the root of your source dir. So this will embed the contents of /path/to/proto/site/_includes/sig.textile into the calling file.

### Code Highlighting

Jekyll has built in support for syntax highlighting of over 100 languages via Pygments. In order to take advantage of this you’ll need to have Pygments installed, and the pygmentize binary must be in your path. When you run Jekyll, make sure you run it with Pygments support

To denote a code block that should be highlighted:

{% highlight ruby %}
def foo
puts 'foo'
end
{% endhighlight %}


The argument to highlight is the language identifier. To find the appropriate identifier to use for your favorite language, look for the “short name” on the Lexers page.

### Line number

There is a second argument to highlight called linenos that is optional. Including the linenos argument will force the highlighted code to include line numbers. For instance, the following code block would include line numbers next to each line:

{% highlight ruby linenos %}
def foo
puts 'foo'
end
{% endhighlight %}


In order for the highlighting to show up, you’ll need to include a highlighting stylesheet. For an example stylesheet you can look at syntax.css. These are the same styles as used by GitHub and you are free to use them for your own site. If you use linenos, you might want to include an additional CSS class definition for lineno in syntax.css to distinguish the line numbers from the highlighted code.

### Post Url

If you would like to include a link to a post on your site, you can use the post_url tag.

{% post_url 2010-07-21-name-of-post %}


There is no need to include the extension.

[Name of Link]({% post_url 2010-07-21-name-of-post %})


# Liquid for Designers

https://github.com/shopify/liquid/wiki/liquid-for-designers

There are two types of markup in Liquid: Output and Tag.

• Output markup (which may resolve to text) is surrounded by
• Tag markup (which cannot resolve to text) is surrounded by

## Output

Here is a simple example of Output:

Output markup takes filters. Filters are simple methods. The first parameter is always the output of the left side of the filter. The return value of the filter will be the new left value when the next filter is run. When there are no more filters, the template will receive the resulting string.

### Standard Filters

• date - reformat a date syntax reference
• capitalize - capitalize words in the input sentence
• downcase - convert an input string to lowercase
• upcase - convert an input string to uppercase
• first - get the first element of the passed in array
• last - get the last element of the passed in array
• join - join elements of the array with certain character between them
• sort - sort elements of the array
• map - map/collect an array on a given property
• size - return the size of an array or string
• escape - escape a string
• escape_once - returns an escaped version of html without affecting existing escaped entities
• strip_html - strip html from string
• strip_newlines - strip all newlines (\n) from string
• newline_to_br - replace each newline (\n) with html break
• replace - replace each occurrence e.g. barbar #=> 'barbar'
• replace_first - replace the first occurrence e.g. foobar #=> 'foobar'
• remove - remove each occurrence e.g. barbar #=> 'barbar'
• remove_first - remove the first occurrence e.g. bar #=> 'bar'
• truncate - truncate a string down to x characters
• truncatewords - truncate a string down to x words
• prepend - prepend a string e.g. foobar #=> 'foobar'
• append - append a string e.g. foobar #=> 'foobar'
• minus - subtraction e.g. 2 #=> 2
• plus - addition e.g. 2 #=> '11', 2 #=> 2
• times - multiplication e.g 20 #=> 20
• divided_by - division e.g. 5 #=> 5
• split - split a string on a matching pattern e.g. a~b #=> ['a','b']
• modulo - remainder, e.g. 1 #=> 1

## Tags

Tags are used for the logic in your template. New tags are very easy to code, so I hope to get many contributions to the standard tag library after releasing this code.

Here is a list of currently supported tags:

• assign - Assigns some value to a variable
• capture - Block tag that captures text into a variable
• case - Block tag, its the standard case…when block
• comment - Block tag, comments out the text in the block
• cycle - Cycle is usually used within a loop to alternate between values, like colors or DOM classes.
• for - For loop
• if - Standard if/else block
• include - Includes another template; useful for partials
• raw - temporarily disable tag processing to avoid syntax conflicts.
• unless - Mirror of if statement

Comment is the simplest tag. It just swallows content.

### Raw

Raw temporarily disables tag processing. This is useful for generating content (eg, Mustache, Handlebars) which uses conflicting syntax.

 {% raw %}   In Handlebars, {{ this }} will be HTML-escaped, but {{{ that }}} will not. {% endraw %} 

### If / Else

if / else should be well-known from any other programming language. Liquid allows you to write simple expressions in the if or unless (and optionally, elsif and else) clause:

### Case Statement

If you need more conditions, you can use the case statement:

Example:

### Cycle

Often you have to alternate between different colors or similar tasks. Liquid has built-in support for such operations, using the cycle tag.

If no name is supplied for the cycle group, then it’s assumed that multiple calls with the same parameters are one group.

If you want to have total control over cycle groups, you can optionally specify the name of the group. This can even be a variable.

### For loops

Liquid allows for loops over collections:

During every for loop, the following helper variables are available for extra styling needs:

There are several attributes you can use to influence which items you receive in your loop

limit:int lets you restrict how many items you get. offset:int lets you start the collection with the nth item.

Reversing the loop

Instead of looping over an existing collection, you can define a range of numbers to loop through. The range can be defined by both literal and variable numbers:

### Variable Assignment

You can store data in your own variables, to be used in output or other tags as desired. The simplest way to create a variable is with the assign tag, which has a pretty straightforward syntax:

Another way of doing this would be to assign true / false values to the variable:

If you want to combine a number of strings into a single string and save it to a variable, you can do that with the capture tag. This tag is a block which “captures” whatever is rendered inside it, then assigns the captured value to the given variable instead of rendering it to the screen.