Jekyll | CloudCannon

Log in Get started

Jekyll Cheatsheet

Learn everything Jekyll is capable of from an exhaustive list of variables, tags, and filters.

Collection variables Docs

directory

docs

files
An array of static files in the collection.
Input
```
{{ site.my_collection.files | size }}
```
Output
```
0
```

label

output
Whether the collection's documents will be output as individual files.
Input
```
{{ site.my_collection.output }}
```
Output
```
true
```
relative_path
The path to the document's source file relative to the site source.
Input
```
{{ site.collections.my_collection.relative_path }}
```
Output
```
_my_collection
```

Document variables Docs

collection

content
The content of the collection item, rendered or un-rendered depending upon what Liquid is being processed and the item is.
Input
```
{{ site.my_collection.first.content }}
```
Output
```
Hello from my_collection.
```
relative_path
The path to the document's source file relative to the site source.
Input
```
{{ site.my_collection.first.relative_path }}
```
Output
```
_my_collection/item.md
```

Global variables Docs

content
page
site

Liquid filters - array Docs

array_to_sentence_string

first

group_by

group_by_exp

join

jsonify

last

map

push

size

sort

uniq

where

where_exp

Liquid filters - date Docs

date
Converts a date into another format.
Input
```
{{ site.time | date: "%a, %b %d, %y" }}
```
Output
```
Wed, Jan 27, 16
```
- %a - Abbreviated weekday (Sun)
- %A - Full weekday name (Sunday)
- %b - Abbreviated month name (Jan)
- %B - Full month name (January)
- %c - Preferred local date and time representation (Fri Jan 29 11:16:09 2016)
- %d - Day of the month, zero-padded (05)
- %-d - Day of the month (5)
- %D - Formats the date (29/01/16).
- %e - Day of the month (3).
- %F - Returns the date in ISO 8601 format (2016-01-29).
- %H - Hour of the day, 24-hour clock (07)
- %I - Hour of the day, 12-hour clock (04)
- %j - Day of the year (017)
- %k - Hour of the day, 24-hour clock (7)
- %m - Month of the year (04)
- %M - Minute of the hour (09)
- %p - Meridian indicator uppercase (AM)
- %P - Meridian indicator lowercase (pm)
- %r - 12-hour time (01:31:43 PM)
- %R - 24-hour time (18:09)
- %T - 24-hour time with seconds (18:09:13)
- %s - Number of seconds since 1970-01-01 00:00:00 UTC (1452355261)
- %S - Second of the minute (05)
- %U - Week number of the current year, starting with the first Sunday as the first day of the first week (03)
- %W - Week number of the current year, starting with the first Monday as the first day of the first week (09)
- %w - Day of the week. Sunday is 0 (4)
- %x - Preferred representation for the date (05/11/15)
- %X - Preferred representation for the time (17:15:31)
- %y - Year without a century (16)
- %Y - Year with century (2016)
- %Z - Time zone name (PST)
- %% - Literal % character
date_to_long_string
Convert a date to long format.
Input
```
{{ site.time | date_to_long_string }}
```
Output
```
01 January 2016
```

date_to_long_rfc822

date_to_string
Convert a date to short format.
Input
```
{{ site.time | date_to_string }}
```
Output
```
01 Jan 2016
```

date_to_xmlschema

Liquid filters - integer Docs

ceil
Rounds a number up to the nearest whole number.
Input
```
{{ 1.2 | ceil }}
```
Output
```
2
```
divided_by
Integer division.
Input
```
{{ 10 | divided_by:3 }}
```
Output
```
3
```
floor
Rounds a number down to the nearest whole number.
Input
```
{{ 1.2 | floor }}
```
Output
```
1
```
minus
Subtraction.
Input
```
{{ 4 | minus:1 }}
```
Output
```
3
```
modulo
Remainder.
Input
```
{{ 3 | modulo:2 }}
```
Output
```
1
```
plus
Addition.
Input
```
{{ 4 | plus:1 }}
```
Output
```
5
```
round
Rounds a number to the nearest whole number.
Input
```
{{ 1.8 | round }}
```
Output
```
2
```
times
Integer multiplication.
Input
```
{{ 10 | times:3 }}
```
Output
```
30
```

Liquid filters - string Docs

absolute_url

append
Append characters to a string.
Input
```
{{ 'jekyll' | append: '.jpg' }}
```
Output
```
jekyll.jpg
```

capitalize

cgi_escape

default
Set a fallback incase a value doesn't exist.
Input
```
{{ nil | default: "hello"  }}
```
Output
```
hello
```

downcase

escape

lstrip

markdownify

number_of_words
Count the number of words in a string.
Input
```
{{ "Hi Jekyll!" | number_of_words }}
```
Output
```
2
```

prepend

relative_url

remove

remove_first
Removes only the first occurrence of a substring from a string.
Input
```
{{ 'I really really like Jekyll' | remove_first: 'really' }}
```
Output
```
I really like Jekyll
```

replace

replace_first

rstrip

sassify

scssify

size

slice

slugify
Convert a string into a lowercase URL slug.
Input
```
{{ "The _config.yml file" | slugify }}
```
Output
```
the-config-yml-file
```
The slugify filter accepts an option, each specifying what to filter. The default is default. They are as follows (with what they filter):
- none: no characters
- raw: spaces
- default: spaces and non-alphanumeric characters
- pretty: spaces and non-alphanumeric characters except for ._~!$&'()+,;=@

smartify

split
Divide a string into an array.
Input
```
{{ "a~b" | split:"~" }}
```
Output
```
['a', 'b']
```

strip

strip_html
Strip all html tags from the input string.
Input
```
{{ "<p>Jekyll is cool</p>" | strip_html }}
```
Output
```
Jekyll is cool
```
strip_newlines
Strip all new line characters from the input string.
Input
```
{{ "Hello
there" | strip_newlines }}
```
Output
```
Hello there
```

truncate

truncatewords
Truncate string down to x words.
Input
```
{{ "I love Jekyll" | truncatewords: 2 }}
```
Output
```
I love...
```

upcase

uri_escape

url_encode
Encodes any characters unsafe for a URL.
Input
```
{{ "john@example.com" | url_encode }}
```
Output
```
john%40example.com
```
xml_escape
Select all the objects in an array where the key has the given value.
Input
```
{{ "<p>Hi Jekyll</p>"| xml_escape }}
```
Output
```
&amp;lt;p&amp;gt;Hi Jekyll&amp;lt;/p&amp;gt;
```

Liquid for loops Docs

else

first

index

index0

last

length

limit

offset

reversed

rindex

rindex0

Liquid tags - control flow Docs

case

elsif

if

operations
Operators used in logic statements.
- == equal
- != not equal
- > bigger than
- < less than
- >= bigger or equal
- <= less or equal
- or this or that
- and must be this and that
- contains includes the substring if used on a string, or element if used on an array

unless

Liquid tags - iteration Docs

break

continue

cycle
Loops through a group of strings and outputs them in the order that they were passed as parameters.
cycle must be used within a for loop block.
Input
```
{% for i in (1..5) %}
  {% cycle 'red', 'blue', 'yellow' %}
{% endfor %}
```
Output
```
red blue yellow red blue
```
decrement
Creates a new variable and every time it's called the value decreases by 1, with the initial value being -1.
Input
```
{% decrement my_variable %}
{% decrement my_variable %}
{% decrement my_variable %}
```
Output
```
-1
-2
-3
```
Like increment, variables declared inside decrement are independent from variables created through assign or capture.

for

increment
Creates a new variable and every time it's called the value increases by 1, with the initial value being 0.
Input
```
{% increment my_variable %}
{% increment my_variable %}
{% increment my_variable %}
```
Output
```
0
1
2
```
Variables created through the increment tag are independent from variables created through assign or capture.
In the example below, my_var is created through assign. The increment tag is then used several times on a variable with the same name. However, note that the increment tag does not affect the value of my_var that was created through assign.
Input
```
{% assign my_var = 15 %}
{% increment var %}
{% increment var %}
{% increment var %}
{{ my_var }}
```
Output
```
0
1
2
15
```

Liquid tags - other Docs

comment

highlight

include

include_relative

link

post_url

raw

Liquid tags - variable Docs

assign

capture
Captures the string inside of the opening and closing tags and assigns it to a variable.
Input
```
{% capture my_variable %}
  Captured text.
{% endcapture %}

{{ my_variable }}
```
Output
```
Captured text.
```

Markdown Docs

blockquotes

code blocks

definition list

headings

horizontal rules
Input
```
---
```
Output
```
<hr />
```

lists

paragraphs

tables

text markup

Page variables Docs

path
The path to the raw post or page.
Input
```
{{ page.path }}
```
Output
```
index.html
```
url
The URL of the Post without the domain, but with a leading slash.
Input
```
{{ page.url }}
```
Output
```
/index.html
```

Post variables Docs

categories

content
The content of the post, rendered or un-rendered depending upon what Liquid is being processed and what `post` is.
Input
```
{{ page.content }}
```
Output
```
Hello World!
```
date
The date assigned to the Post.
Input
```
{{ page.date }}
```
Output
```
2016-02-02 00:00:00 -0800
```
excerpt
The un-rendered excerpt of the Post.
Input
```
{{ page.excerpt }}
```
Output
```
Hello World!
```
id
An identifier unique to the Post.
Input
```
{{ page.id }}
```
Output
```
/2015/10/11/hello-world
```
next
The next post relative to the position of the current post in `site.posts`. Returns `nil` for the last entry.
Input
```
{{ page.next.title }}
```
Output
```
/2016/01/02/hello-world.html
```
previous
The previous post relative to the position of the current post in `site.posts`. Returns `nil` for the first entry.
Input
```
{{ page.previous.title }}
```
Output
```
/2016/01/02/im-fleeting.html
```

tags

title
The title of the post.
Input
```
{{ page.title }}
```
Output
```
Hello World
```

Site variables Docs

categories.category

collections
A list of all the collections.
Input
```
{{ site.collections | size }}
```
Output
```
1
```
configuration data
All the variables set via the command line and your `_config.yml` are available through `site`.
Input
```

{{ site.url }}
```
Output
```
http://mysite.com
```
data
A list containing the data loaded from the YAML, JSON and CSV files located in the _data directory.
Input
```
{{ site.data.nba_players.first.name }}
```
Output
```
Michael Jordan
```
documents
A list of all the documents in every collection.
Input
```
{{ site.documents | size }}
```
Output
```
19
```

html_pages

pages

posts

related_posts
If the page being processed is a Post, this contains a list of up to ten related Posts. By default, these are the ten most recent posts.
Input
```

{% for p in site.related_posts %}
  {{ p.title }}
{% endfor %}
```
Output
```
Goodbye World
Im Fleeting
```
static_files
A list of all static files (i.e. files not processed by Jekyll's converters or the Liquid renderer).
Input
```
{% for file in site.static_files %}
  {{ file.path }}
{% endfor %}
```
Output
```
/css/style.css
/js/my-script.js
```

tags.tag

time
The current time (when you run the jekyll command).
Input
```
{{ site.time }}
```
Output
```
2016-01-28 08:32:19 -0800
```

Static file variables Docs

extname
The extension name for the file.
Input
```
{{ site.static_files.first.extname }}
```
Output
```
.css
```
modified_time
The time the file was last modified.
Input
```
{{ site.static_files.first.modified_time }}
```
Output
```
1454000258
```

path

Yaml Docs

hashes

sequences

variables