...and many more!
+...and many more
diff --git a/_includes/icons/desktop-download.svg b/_includes/icons/desktop-download.svg new file mode 100755 index 0000000..0ae8dcd --- /dev/null +++ b/_includes/icons/desktop-download.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/_includes/icons/mark-github.svg b/_includes/icons/mark-github.svg new file mode 100755 index 0000000..0fecf16 --- /dev/null +++ b/_includes/icons/mark-github.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/_includes/icons/three-bars.svg b/_includes/icons/three-bars.svg new file mode 100755 index 0000000..dcf5035 --- /dev/null +++ b/_includes/icons/three-bars.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/_layouts/default.html b/_layouts/default.html index 0af9326..0d2a43a 100644 --- a/_layouts/default.html +++ b/_layouts/default.html @@ -1,35 +1,56 @@ + + + +Input
+{% raw %} +```liquid +{% assign site_categories = site.pages | map: 'category' %} + +{% for category in site_categories %} + {{ category }} +{% endfor %} +``` +{% endraw %} + +Output
+```text + business + celebrities + + lifestyle + sports + + technology +``` + +By using `compact` when we create our `site_categories` array, we can remove all the `nil` values in the array. + +Input
+{% raw %} +```liquid +{% assign site_categories = site.pages | map: 'category' | compact %} + +{% for category in site_categories %} + {{ category }} +{% endfor %} +``` +{% endraw %} + +Output
+```text + business + celebrities + lifestyle + sports + technology +``` diff --git a/filters/date.md b/filters/date.md index 09f67f1..5423221 100644 --- a/filters/date.md +++ b/filters/date.md @@ -1,5 +1,6 @@ --- title: date +description: Liquid filter that prints and formats dates. --- Converts a timestamp into another date format. The format for this syntax is the same as [`strftime`](http://strftime.net). diff --git a/filters/default.md b/filters/default.md index 96249a1..9437cd5 100644 --- a/filters/default.md +++ b/filters/default.md @@ -1,5 +1,6 @@ --- title: default +description: Liquid filter that specifies a fallback in case a value doesn't exist. --- Allows you to specify a fallback in case a value doesn't exist. `default` will show its value if the left side is `nil`, `false`, or empty. diff --git a/filters/divided_by.md b/filters/divided_by.md index fc6abc3..7099708 100644 --- a/filters/divided_by.md +++ b/filters/divided_by.md @@ -1,5 +1,6 @@ --- title: divided_by +description: Liquid filter that divides a number by another number. --- Divides a number by the specified number. diff --git a/filters/downcase.md b/filters/downcase.md index eaec276..d08224c 100644 --- a/filters/downcase.md +++ b/filters/downcase.md @@ -1,5 +1,6 @@ --- title: downcase +description: Liquid filter that coverts a string to lowercase. --- Makes each character in a string lowercase. It has no effect on strings which are already all lowercase. diff --git a/filters/escape.md b/filters/escape.md index 777fd7a..479325b 100644 --- a/filters/escape.md +++ b/filters/escape.md @@ -1,5 +1,6 @@ --- title: escape +description: Liquid filter that escapes URL-unsafe characters in a string. --- Escapes a string by replacing characters with escape sequences (so that the string can be used in a URL, for example). It doesn't change strings that don't have anything to escape. diff --git a/filters/escape_once.md b/filters/escape_once.md index 3edcae3..6ee787e 100644 --- a/filters/escape_once.md +++ b/filters/escape_once.md @@ -1,5 +1,6 @@ --- title: escape_once +description: Liquid filter that escapes URL-unsafe characters in a string once. --- Escapes a string without changing existing escaped entities. It doesn't change strings that don't have anything to escape. diff --git a/filters/first.md b/filters/first.md index f87479b..4d80f1e 100644 --- a/filters/first.md +++ b/filters/first.md @@ -1,5 +1,6 @@ --- title: first +description: Liquid filter that returns the first item of an array. --- Returns the first item of an array. diff --git a/filters/floor.md b/filters/floor.md index dccc10e..3e6a597 100644 --- a/filters/floor.md +++ b/filters/floor.md @@ -1,5 +1,6 @@ --- title: floor +description: Liquid filter that gets the floor of a number by rounding down to the nearest integer. --- Rounds a number down to the nearest whole number. Liquid tries to convert the input to a number before the filter is applied. diff --git a/filters/index.md b/filters/index.md index 14bda7c..aec1972 100644 --- a/filters/index.md +++ b/filters/index.md @@ -1,14 +1,3 @@ --- -title: Filters -type: index +redirect_to: /liquid/filters/abs --- - -**Filters** change the output of a Liquid object. You can append one or more filters to an object by separating the filter and its parameters by a pipe symbol `|`. - -{% assign filter_pages = site.pages | where: 'type', 'filter' %} - -{% for item in filter_pages %} -## [{{ item.title }}]({{ item.url | prepend: site.baseurl }}) - -{{ item.content }} -{% endfor %} diff --git a/filters/join.md b/filters/join.md index c0dee8d..2cd589c 100644 --- a/filters/join.md +++ b/filters/join.md @@ -1,5 +1,6 @@ --- title: join +description: Liquid filter that joins an array of strings into a single string. --- Combines the items in an array into a single string using the argument as a separator. diff --git a/filters/last.md b/filters/last.md index 5f3c680..1273078 100644 --- a/filters/last.md +++ b/filters/last.md @@ -1,5 +1,6 @@ --- title: last +description: Liquid filter that gets the last value in an array. --- Returns the last item of an array. diff --git a/filters/lstrip.md b/filters/lstrip.md index b143bb3..be8c19c 100644 --- a/filters/lstrip.md +++ b/filters/lstrip.md @@ -1,5 +1,6 @@ --- title: lstrip +description: Liquid filter that removes whitespace from the left side of a string. --- Removes all whitespaces (tabs, spaces, and newlines) from the beginning of a string. The filter does not affect spaces between words. diff --git a/filters/map.md b/filters/map.md index 61fddb9..9b352a8 100644 --- a/filters/map.md +++ b/filters/map.md @@ -1,5 +1,6 @@ --- title: map +description: Liquid filter that creates an array of values by extracting a named property from an object. --- Creates an array of values by extracting the values of a named property from another object. diff --git a/filters/minus.md b/filters/minus.md index f9d4474..0b0ffc7 100644 --- a/filters/minus.md +++ b/filters/minus.md @@ -1,5 +1,6 @@ --- title: minus +description: Liquid filter that subtracts one number from another. --- Subtracts a number from another number. diff --git a/filters/modulo.md b/filters/modulo.md index bb31570..38e538c 100644 --- a/filters/modulo.md +++ b/filters/modulo.md @@ -1,5 +1,6 @@ --- title: modulo +description: Liquid filter that returns the remainder from a division operation. --- Returns the remainder of a division operation. diff --git a/filters/newline_to_br.md b/filters/newline_to_br.md index a936e40..5b694da 100644 --- a/filters/newline_to_br.md +++ b/filters/newline_to_br.md @@ -1,5 +1,6 @@ --- title: newline_to_br +description: Liquid filter that converts newlines in an input string to HTMLInput
+```liquid +{% raw %} +{% assign my_array = "zebra, octopus, giraffe, Sally Snake" | split: ", " %} + +{{ my_array | sort_natural | join: ", " }} +{% endraw %} +``` + +Output
+```text +giraffe, octopus, Sally Snake, zebra +``` diff --git a/filters/split.md b/filters/split.md index b56218a..17a72d1 100644 --- a/filters/split.md +++ b/filters/split.md @@ -1,5 +1,6 @@ --- title: split +description: Liquid filter that splits a string into an array using separators. --- Divides an input string into an array using the argument as a separator. `split` is commonly used to convert comma-separated items from a string to an array. diff --git a/filters/strip.md b/filters/strip.md index 97218d7..6885ac4 100644 --- a/filters/strip.md +++ b/filters/strip.md @@ -1,5 +1,6 @@ --- title: strip +description: Liquid filter that removes whitespace from the left and right sides of a string. --- Removes all whitespace (tabs, spaces, and newlines) from both the left and right side of a string. It does not affect spaces between words. diff --git a/filters/strip_html.md b/filters/strip_html.md index 3c9a3d1..9ca00f0 100644 --- a/filters/strip_html.md +++ b/filters/strip_html.md @@ -1,5 +1,6 @@ --- title: strip_html +description: Liquid filter that removes HTML tags from a string. --- Removes any HTML tags from a string. diff --git a/filters/strip_newlines.md b/filters/strip_newlines.md index 675ff40..c05deaa 100644 --- a/filters/strip_newlines.md +++ b/filters/strip_newlines.md @@ -1,5 +1,6 @@ --- title: strip_newlines +description: Liquid filter that removes newline characters from a string. --- Removes any newline characters (line breaks) from a string. diff --git a/filters/times.md b/filters/times.md index 76e71c6..634c7e4 100644 --- a/filters/times.md +++ b/filters/times.md @@ -1,5 +1,6 @@ --- title: times +description: Liquid filter that multiplies a number by another number. --- Multiplies a number by another number. diff --git a/filters/truncate.md b/filters/truncate.md index f3ebcbe..8103cb2 100644 --- a/filters/truncate.md +++ b/filters/truncate.md @@ -1,5 +1,6 @@ --- title: truncate +description: Liquid filter that truncates a string to a given number of characters. --- `truncate` shortens a string down to the number of characters passed as a parameter. If the number of characters specified is less than the length of the string, an ellipsis (...) is appended to the string and is included in the character count. diff --git a/filters/truncatewords.md b/filters/truncatewords.md index b2480e2..0a2d8ef 100644 --- a/filters/truncatewords.md +++ b/filters/truncatewords.md @@ -1,5 +1,6 @@ --- title: truncatewords +description: Liquid filter that truncates a string to the given number of words. --- Shortens a string down to the number of words passed as the argument. If the specified number of words is less than the number of words in the string, an ellipsis (...) is appended to the string. diff --git a/filters/uniq.md b/filters/uniq.md index 4846437..e02b4e9 100644 --- a/filters/uniq.md +++ b/filters/uniq.md @@ -1,5 +1,6 @@ --- title: uniq +description: Liquid filter that removes duplicate items from an array. --- Removes any duplicate elements in an array. diff --git a/filters/upcase.md b/filters/upcase.md index 105d3d1..1c6112c 100644 --- a/filters/upcase.md +++ b/filters/upcase.md @@ -1,5 +1,6 @@ --- title: upcase +description: Liquid filter that capitalizes every character in a string. --- Makes each character in a string uppercase. It has no effect on strings which are already all uppercase. diff --git a/filters/url_decode.md b/filters/url_decode.md new file mode 100644 index 0000000..e6f1991 --- /dev/null +++ b/filters/url_decode.md @@ -0,0 +1,18 @@ +--- +title: url_decode +description: Liquid filter that decodes percent-encoded characters in a string. +--- + +Decodes a string that has been encoded as a URL or by [`url_encode`]({{ '/filters/url_encode' | prepend: site.baseurl }}). + +Input
+```liquid +{% raw %} +{{ "%27Stop%21%27+said+Fred" | url_decode }} +{% endraw %} +``` + +Output
+```text +'Stop!' said Fred +``` diff --git a/filters/url_encode.md b/filters/url_encode.md index f0f5add..5a17c81 100644 --- a/filters/url_encode.md +++ b/filters/url_encode.md @@ -1,5 +1,6 @@ --- title: url_encode +description: Liquid filter that encodes URL-unsafe characters in a string. --- Converts any URL-unsafe characters in a string into percent-encoded characters. diff --git a/images/icons/water-drop-128x.png b/images/icons/water-drop-128x.png new file mode 100644 index 0000000..1b37db8 Binary files /dev/null and b/images/icons/water-drop-128x.png differ diff --git a/images/icons/water-drop-32x.png b/images/icons/water-drop-32x.png new file mode 100644 index 0000000..ffdaa3b Binary files /dev/null and b/images/icons/water-drop-32x.png differ diff --git a/images/icons/water-drop-64x.png b/images/icons/water-drop-64x.png new file mode 100644 index 0000000..64b55c4 Binary files /dev/null and b/images/icons/water-drop-64x.png differ diff --git a/index.md b/index.md index 7ce0a6a..1cf1975 100644 --- a/index.md +++ b/index.md @@ -1,16 +1,14 @@ --- layout: default +description: Documentation for the Liquid template language, created by Shopify. --- {% include home-banner.html %} -## What is Liquid? - Liquid is an open-source template language created by [Shopify](https://www.shopify.com) and written in Ruby. It is the backbone of Shopify themes and is used to load dynamic content on storefronts. -Liquid has been in production use since June 2006 and is now used by many other hosted web applications. +Liquid has been in production use at Shopify since 2006 and is now used by many other hosted web applications. -## Who uses Liquid? +## Used by {% include home-users-grid.html %} - diff --git a/js/vendor/jquery-3.1.1.slim.min.js b/js/vendor/jquery-3.1.1.slim.min.js new file mode 100644 index 0000000..a240ca9 --- /dev/null +++ b/js/vendor/jquery-3.1.1.slim.min.js @@ -0,0 +1,4 @@ +/*! jQuery v3.1.1 -ajax,-ajax/jsonp,-ajax/load,-ajax/parseXML,-ajax/script,-ajax/var/location,-ajax/var/nonce,-ajax/var/rquery,-ajax/xhr,-manipulation/_evalUrl,-event/ajax,-effects,-effects/animatedSelector,-effects/Tween,-deprecated | (c) jQuery Foundation | jquery.org/license */ +!function(a,b){"use strict";"object"==typeof module&&"object"==typeof module.exports?module.exports=a.document?b(a,!0):function(a){if(!a.document)throw new Error("jQuery requires a window with a document");return b(a)}:b(a)}("undefined"!=typeof window?window:this,function(a,b){"use strict";var c=[],d=a.document,e=Object.getPrototypeOf,f=c.slice,g=c.concat,h=c.push,i=c.indexOf,j={},k=j.toString,l=j.hasOwnProperty,m=l.toString,n=m.call(Object),o={};function p(a,b){b=b||d;var c=b.createElement("script");c.text=a,b.head.appendChild(c).parentNode.removeChild(c)}var q="3.1.1 -ajax,-ajax/jsonp,-ajax/load,-ajax/parseXML,-ajax/script,-ajax/var/location,-ajax/var/nonce,-ajax/var/rquery,-ajax/xhr,-manipulation/_evalUrl,-event/ajax,-effects,-effects/animatedSelector,-effects/Tween,-deprecated",r=function(a,b){return new r.fn.init(a,b)},s=/^[\s\uFEFF\xA0]+|[\s\uFEFF\xA0]+$/g,t=/^-ms-/,u=/-([a-z])/g,v=function(a,b){return b.toUpperCase()};r.fn=r.prototype={jquery:q,constructor:r,length:0,toArray:function(){return f.call(this)},get:function(a){return null==a?f.call(this):a<0?this[a+this.length]:this[a]},pushStack:function(a){var b=r.merge(this.constructor(),a);return b.prevObject=this,b},each:function(a){return r.each(this,a)},map:function(a){return this.pushStack(r.map(this,function(b,c){return a.call(b,c,b)}))},slice:function(){return this.pushStack(f.apply(this,arguments))},first:function(){return this.eq(0)},last:function(){return this.eq(-1)},eq:function(a){var b=this.length,c=+a+(a<0?b:0);return this.pushStack(c>=0&&cAllows you to leave un-rendered code inside a Liquid template. Any text within the opening and closing comment blocks will not be output, and any Liquid code within will not be executed.
with parameter assigns a value to a variable inside a snippet that shares the same name as the snippet.
-
-For example, we can have a snippet named **color.liquid** which contains the following:
-
-{% highlight html %}{% raw %}
-color: '{{ color }}'
-shape: '{{ shape }}'
-{% endraw %}{% endhighlight %}
-
-Within **theme.liquid**, we can include the **color.liquid** snippet as follows:
-
-{% highlight html %}{% raw %}
-{% assign shape = 'circle' %}
-{% include 'color' %}
-{% include 'color' with 'red' %}
-{% include 'color' with 'blue' %}
-{% assign shape = 'square' %}
-{% include 'color' with 'red' %}
-{% endraw %}{% endhighlight %}
-
-The output will be:
-
-{% highlight html %}{% raw %}
-color: shape: 'circle'
-color: 'red' shape: 'circle'
-color: 'blue' shape: 'circle'
-color: 'red' shape: 'square'
-{% endraw %}{% endhighlight %}
-
-### form
-
-Creates an HTML <form> element with all the necessary attributes (action, id, etc.) and <input> to submit the form successfully.
-
-article object as a parameter.
-
-Input
-Output
-none.
-
-{% highlight html %}{% raw %}
-{% layout none %}
-{% endraw %}{% endhighlight %}
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-### paginate
-
-Splitting products, blog articles, and search results across multiple pages is a necessary component of theme design as you are limited to 50 results per page in any for loop.
-
-The paginate tag works in conjunction with the for tag to split content into numerous pages. It must wrap a for tag block that loops through an array, as shown in the example below:
-
-{% highlight html %}{% raw %}
-{% paginate collection.products by 5 %}
- {% for product in collection.products %}
-
- {% endfor %}
-{% endpaginate %}
-{% endraw %}{% endhighlight %}
-
-The by parameter is followed by an integer between 1 and 50 that tells the paginate tag how many results it should output per page.
-
-
-Within paginate tags, you can access attributes of the paginate object. This includes the attributes to output the links required to navigate within the generated pages.
-
-
-{% comment %}
-
-Accessing any attributes of the array you are paginating before the opening paginate tag will cause errors. To avoid this, make sure any variables
-
-
-**Bad Example**
-Allows output of Liquid code on a page without being parsed.
- -Input
- -{% raw %}{{ 5 | plus: 6 }}{% endraw %} is equal to 11.Output
- -{{ 5 | plus: 6 }} is equal to 11.Input
-```liquid -{% raw %} -{% assign handle = 'cake' %} -{% case handle %} - {% when 'cake' %} - This is a cake - {% when 'cookie' %} - This is a cookie - {% else %} - This is not a cake nor a cookie -{% endcase %} -{% endraw %} -``` - -Output
-```text -This is a cake -``` - ## if Executes a block of code only if a certain condition is `true`. @@ -96,3 +73,27 @@ Adds more conditions within an `if` or `unless` block. ```text Hey Anonymous! ``` + +## case/when + +Creates a switch statement to compare a variable with different values. `case` initializes the switch statement, and `when` compares its values. + +Input
+```liquid +{% raw %} +{% assign handle = 'cake' %} +{% case handle %} + {% when 'cake' %} + This is a cake + {% when 'cookie' %} + This is a cookie + {% else %} + This is not a cake nor a cookie +{% endcase %} +{% endraw %} +``` + +Output
+```text +This is a cake +``` diff --git a/tags/index.md b/tags/index.md index 94dfb28..4675878 100644 --- a/tags/index.md +++ b/tags/index.md @@ -1,16 +1,3 @@ --- -title: Tags -type: index +redirect_to: /liquid/tags/control-flow --- - -**Tags** create the logic and control flow for templates. They are denoted by curly braces and percent signs: {% raw %}`{%` and `%}`{% endraw %}. - -The markup used in tags does not produce any visible text. This means that you can assign variables and create conditions and loops without showing any of the Liquid logic on the page. - -{% assign tag_pages = site.pages | where: 'type', 'tag' %} - -{% for item in tag_pages %} -## [{{ item.title }}]({{ item.url | prepend: site.baseurl }}) - -{{ item.content }} -{% endfor %} diff --git a/tags/iteration.md b/tags/iteration.md index c8ecc4a..e411a72 100644 --- a/tags/iteration.md +++ b/tags/iteration.md @@ -1,5 +1,6 @@ --- title: Iteration +description: An overview of iteration or 'loop' tags in the Liquid template language. --- Iteration tags run blocks of code repeatedly. diff --git a/tags/variable.md b/tags/variable.md index 920bdd0..16ca9d5 100644 --- a/tags/variable.md +++ b/tags/variable.md @@ -1,5 +1,6 @@ --- title: Variable +description: An overview of tags for creating variables in the Liquid template language. --- Variable tags create new Liquid variables.