diff --git a/Gemfile.lock b/Gemfile.lock deleted file mode 100644 index 76e319405..000000000 --- a/Gemfile.lock +++ /dev/null @@ -1,265 +0,0 @@ -GEM - remote: https://rubygems.org/ - specs: - activesupport (6.0.3.5) - concurrent-ruby (~> 1.0, >= 1.0.2) - i18n (>= 0.7, < 2) - minitest (~> 5.1) - tzinfo (~> 1.1) - zeitwerk (~> 2.2, >= 2.2.2) - addressable (2.7.0) - public_suffix (>= 2.0.2, < 5.0) - coffee-script (2.4.1) - coffee-script-source - execjs - coffee-script-source (1.11.1) - colorator (1.1.0) - commonmarker (0.17.13) - ruby-enum (~> 0.5) - concurrent-ruby (1.1.8) - dnsruby (1.61.5) - simpleidn (~> 0.1) - em-websocket (0.5.2) - eventmachine (>= 0.12.9) - http_parser.rb (~> 0.6.0) - ethon (0.12.0) - ffi (>= 1.3.0) - eventmachine (1.2.7) - execjs (2.7.0) - faraday (1.3.0) - faraday-net_http (~> 1.0) - multipart-post (>= 1.2, < 3) - ruby2_keywords - faraday-net_http (1.0.1) - ffi (1.15.0) - forwardable-extended (2.6.0) - gemoji (3.0.1) - github-pages (212) - github-pages-health-check (= 1.17.0) - jekyll (= 3.9.0) - jekyll-avatar (= 0.7.0) - jekyll-coffeescript (= 1.1.1) - jekyll-commonmark-ghpages (= 0.1.6) - jekyll-default-layout (= 0.1.4) - jekyll-feed (= 0.15.1) - jekyll-gist (= 1.5.0) - jekyll-github-metadata (= 2.13.0) - jekyll-mentions (= 1.6.0) - jekyll-optional-front-matter (= 0.3.2) - jekyll-paginate (= 1.1.0) - jekyll-readme-index (= 0.3.0) - jekyll-redirect-from (= 0.16.0) - jekyll-relative-links (= 0.6.1) - jekyll-remote-theme (= 0.4.2) - jekyll-sass-converter (= 1.5.2) - jekyll-seo-tag (= 2.7.1) - jekyll-sitemap (= 1.4.0) - jekyll-swiss (= 1.0.0) - jekyll-theme-architect (= 0.1.1) - jekyll-theme-cayman (= 0.1.1) - jekyll-theme-dinky (= 0.1.1) - jekyll-theme-hacker (= 0.1.2) - jekyll-theme-leap-day (= 0.1.1) - jekyll-theme-merlot (= 0.1.1) - jekyll-theme-midnight (= 0.1.1) - jekyll-theme-minimal (= 0.1.1) - jekyll-theme-modernist (= 0.1.1) - jekyll-theme-primer (= 0.5.4) - jekyll-theme-slate (= 0.1.1) - jekyll-theme-tactile (= 0.1.1) - jekyll-theme-time-machine (= 0.1.1) - jekyll-titles-from-headings (= 0.5.3) - jemoji (= 0.12.0) - kramdown (= 2.3.0) - kramdown-parser-gfm (= 1.1.0) - liquid (= 4.0.3) - mercenary (~> 0.3) - minima (= 2.5.1) - nokogiri (>= 1.10.4, < 2.0) - rouge (= 3.26.0) - terminal-table (~> 1.4) - github-pages-health-check (1.17.0) - addressable (~> 2.3) - dnsruby (~> 1.60) - octokit (~> 4.0) - public_suffix (>= 2.0.2, < 5.0) - typhoeus (~> 1.3) - html-pipeline (2.14.0) - activesupport (>= 2) - nokogiri (>= 1.4) - http_parser.rb (0.6.0) - i18n (0.9.5) - concurrent-ruby (~> 1.0) - jekyll (3.9.0) - addressable (~> 2.4) - colorator (~> 1.0) - em-websocket (~> 0.5) - i18n (~> 0.7) - jekyll-sass-converter (~> 1.0) - jekyll-watch (~> 2.0) - kramdown (>= 1.17, < 3) - liquid (~> 4.0) - mercenary (~> 0.3.3) - pathutil (~> 0.9) - rouge (>= 1.7, < 4) - safe_yaml (~> 1.0) - jekyll-avatar (0.7.0) - jekyll (>= 3.0, < 5.0) - jekyll-coffeescript (1.1.1) - coffee-script (~> 2.2) - coffee-script-source (~> 1.11.1) - jekyll-commonmark (1.3.1) - commonmarker (~> 0.14) - jekyll (>= 3.7, < 5.0) - jekyll-commonmark-ghpages (0.1.6) - commonmarker (~> 0.17.6) - jekyll-commonmark (~> 1.2) - rouge (>= 2.0, < 4.0) - jekyll-default-layout (0.1.4) - jekyll (~> 3.0) - jekyll-feed (0.15.1) - jekyll (>= 3.7, < 5.0) - jekyll-gist (1.5.0) - octokit (~> 4.2) - jekyll-github-metadata (2.13.0) - jekyll (>= 3.4, < 5.0) - octokit (~> 4.0, != 4.4.0) - jekyll-mentions (1.6.0) - html-pipeline (~> 2.3) - jekyll (>= 3.7, < 5.0) - jekyll-optional-front-matter (0.3.2) - jekyll (>= 3.0, < 5.0) - jekyll-paginate (1.1.0) - jekyll-readme-index (0.3.0) - jekyll (>= 3.0, < 5.0) - jekyll-redirect-from (0.16.0) - jekyll (>= 3.3, < 5.0) - jekyll-relative-links (0.6.1) - jekyll (>= 3.3, < 5.0) - jekyll-remote-theme (0.4.2) - addressable (~> 2.0) - jekyll (>= 3.5, < 5.0) - jekyll-sass-converter (>= 1.0, <= 3.0.0, != 2.0.0) - rubyzip (>= 1.3.0, < 3.0) - jekyll-sass-converter (1.5.2) - sass (~> 3.4) - jekyll-seo-tag (2.7.1) - jekyll (>= 3.8, < 5.0) - jekyll-sitemap (1.4.0) - jekyll (>= 3.7, < 5.0) - jekyll-swiss (1.0.0) - jekyll-theme-architect (0.1.1) - jekyll (~> 3.5) - jekyll-seo-tag (~> 2.0) - jekyll-theme-cayman (0.1.1) - jekyll (~> 3.5) - jekyll-seo-tag (~> 2.0) - jekyll-theme-dinky (0.1.1) - jekyll (~> 3.5) - jekyll-seo-tag (~> 2.0) - jekyll-theme-hacker (0.1.2) - jekyll (> 3.5, < 5.0) - jekyll-seo-tag (~> 2.0) - jekyll-theme-leap-day (0.1.1) - jekyll (~> 3.5) - jekyll-seo-tag (~> 2.0) - jekyll-theme-merlot (0.1.1) - jekyll (~> 3.5) - jekyll-seo-tag (~> 2.0) - jekyll-theme-midnight (0.1.1) - jekyll (~> 3.5) - jekyll-seo-tag (~> 2.0) - jekyll-theme-minimal (0.1.1) - jekyll (~> 3.5) - jekyll-seo-tag (~> 2.0) - jekyll-theme-modernist (0.1.1) - jekyll (~> 3.5) - jekyll-seo-tag (~> 2.0) - jekyll-theme-primer (0.5.4) - jekyll (> 3.5, < 5.0) - jekyll-github-metadata (~> 2.9) - jekyll-seo-tag (~> 2.0) - jekyll-theme-slate (0.1.1) - jekyll (~> 3.5) - jekyll-seo-tag (~> 2.0) - jekyll-theme-tactile (0.1.1) - jekyll (~> 3.5) - jekyll-seo-tag (~> 2.0) - jekyll-theme-time-machine (0.1.1) - jekyll (~> 3.5) - jekyll-seo-tag (~> 2.0) - jekyll-titles-from-headings (0.5.3) - jekyll (>= 3.3, < 5.0) - jekyll-watch (2.2.1) - listen (~> 3.0) - jemoji (0.12.0) - gemoji (~> 3.0) - html-pipeline (~> 2.2) - jekyll (>= 3.0, < 5.0) - kramdown (2.3.0) - rexml - kramdown-parser-gfm (1.1.0) - kramdown (~> 2.0) - liquid (4.0.3) - listen (3.4.1) - rb-fsevent (~> 0.10, >= 0.10.3) - rb-inotify (~> 0.9, >= 0.9.10) - mercenary (0.3.6) - mini_portile2 (2.5.0) - minima (2.5.1) - jekyll (>= 3.5, < 5.0) - jekyll-feed (~> 0.9) - jekyll-seo-tag (~> 2.1) - minitest (5.14.4) - multipart-post (2.1.1) - nokogiri (1.11.1) - mini_portile2 (~> 2.5.0) - racc (~> 1.4) - octokit (4.20.0) - faraday (>= 0.9) - sawyer (~> 0.8.0, >= 0.5.3) - pathutil (0.16.2) - forwardable-extended (~> 2.6) - public_suffix (4.0.6) - racc (1.5.2) - rb-fsevent (0.10.4) - rb-inotify (0.10.1) - ffi (~> 1.0) - rexml (3.2.4) - rouge (3.26.0) - ruby-enum (0.9.0) - i18n - ruby2_keywords (0.0.4) - rubyzip (2.3.0) - safe_yaml (1.0.5) - sass (3.7.4) - sass-listen (~> 4.0.0) - sass-listen (4.0.0) - rb-fsevent (~> 0.9, >= 0.9.4) - rb-inotify (~> 0.9, >= 0.9.7) - sawyer (0.8.2) - addressable (>= 2.3.5) - faraday (> 0.8, < 2.0) - simpleidn (0.2.1) - unf (~> 0.1.4) - terminal-table (1.8.0) - unicode-display_width (~> 1.1, >= 1.1.1) - thread_safe (0.3.6) - typhoeus (1.4.0) - ethon (>= 0.9.0) - tzinfo (1.2.9) - thread_safe (~> 0.1) - unf (0.1.4) - unf_ext - unf_ext (0.0.7.7) - unicode-display_width (1.7.0) - zeitwerk (2.4.2) - -PLATFORMS - ruby - -DEPENDENCIES - github-pages (>= 180) - -BUNDLED WITH - 2.1.4 diff --git a/_basics/introduction.md b/_basics/introduction.md index 8e080a4d2..cdf3fd48e 100644 --- a/_basics/introduction.md +++ b/_basics/introduction.md @@ -4,15 +4,15 @@ description: An overview of objects, tags, and filters in the Liquid template la redirect_from: /basics/ --- -Liquid code can be categorized into [**objects**](#objects), [**tags**](#tags), and [**filters**](#filters). +Liquid uses a combination of [**objects**](#objects), [**tags**](#tags), and [**filters**](#filters) inside **template files** to display dynamic content. ## Objects -**Objects** tell Liquid where to show content on a page. Objects and variable names are denoted by double curly braces: `{% raw %}{{{% endraw %}` and `{% raw %}}}{% endraw %}`. +**Objects** contain the content that Liquid displays on a page. Objects and variables are displayed when enclosed in double curly braces: `{% raw %}{{{% endraw %}` and `{% raw %}}}{% endraw %}`.
Input
```liquid -{% raw %} +{%- raw -%} {{ page.title }} {% endraw %} ``` @@ -22,17 +22,15 @@ Liquid code can be categorized into [**objects**](#objects), [**tags**](#tags), {{ page.title }} ``` -In this case, Liquid is rendering the content of an object called `page.title`, and that object contains the text `Introduction`. +In this case, Liquid is rendering the content of the `title` property of the `page` object, which contains the text `{{ page.title }}`. ## Tags -**Tags** create the logic and control flow for templates. They are denoted by curly braces and percent signs: `{% raw %}{%{% endraw %}` and `{% raw %}%}{% 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. +**Tags** create the logic and control flow for templates. The curly brace percentage delimiters `{% raw %}{%{% endraw %}` and `{% raw %}%}{% endraw %}` and the text that they surround do not produce any visible output when the template is rendered. This lets you assign variables and create conditions or loops without showing any of the Liquid logic on the page.Input
```liquid -{% raw %} +{%- raw -%} {% if user %} Hello {{ user.name }}! {% endif %} @@ -41,24 +39,25 @@ The markup used in tags does not produce any visible text. This means that you cOutput
```text -Hello Adam! + Hello Adam! ``` -Tags can be categorized into three types: +Tags can be categorized into various types: - [Control flow]({{ "/tags/control-flow/" | prepend: site.baseurl }}) - [Iteration]({{ "/tags/iteration/" | prepend: site.baseurl }}) -- [Variable assignments]({{ "/tags/variable/" | prepend: site.baseurl }}) +- [Template]({{ "/tags/template/" | prepend: site.baseurl }}) +- [Variable assignment]({{ "/tags/variable/" | prepend: site.baseurl }}) You can read more about each type of tag in their respective sections. ## Filters -**Filters** change the output of a Liquid object. They are used within an output and are separated by a `|`. +**Filters** change the output of a Liquid object or variable. They are used within double curly braces `{% raw %}{{ }}{% endraw %}` and [variable assignment]({{ "/tags/variable/" | prepend: site.baseurl }}), and are separated by a pipe character `|`.Input
```liquid -{% raw %} +{%- raw -%} {{ "/my/fancy/url" | append: ".html" }} {% endraw %} ``` @@ -68,11 +67,11 @@ You can read more about each type of tag in their respective sections. {{ "/my/fancy/url" | append: ".html" }} ``` -Multiple filters can be used on one output. They are applied from left to right. +Multiple filters can be used on one output, and are applied from left to right.Input
```liquid -{% raw %} +{%- raw -%} {{ "adam!" | capitalize | prepend: "Hello " }} {% endraw %} ``` diff --git a/_basics/operators.md b/_basics/operators.md index 0f945cfe5..a1858c968 100644 --- a/_basics/operators.md +++ b/_basics/operators.md @@ -3,7 +3,7 @@ title: Operators description: Using operators to perform calculations in the Liquid template language. --- -Liquid includes many logical and comparison operators. +Liquid includes many logical and comparison operators. You can use operators to create logic with [control flow]({{ "/tags/control-flow/" | prepend: site.baseurl }}) tags. ## Basic operators @@ -47,17 +47,17 @@ Liquid includes many logical and comparison operators. For example: ```liquid -{% raw %} +{%- raw -%} {% if product.title == "Awesome Shoes" %} These shoes are awesome! {% endif %} {% endraw %} ``` -You can use multiple operators in a tag: +You can do multiple comparisons in a tag using the `and` and `or` operators: ```liquid -{% raw %} +{%- raw -%} {% if product.type == "Shirt" or product.type == "Shoes" %} This is a shirt or a pair of shoes. {% endif %} @@ -69,7 +69,7 @@ You can use multiple operators in a tag: `contains` checks for the presence of a substring inside a string. ```liquid -{% raw %} +{%- raw -%} {% if product.title contains "Pack" %} This product's title contains the word Pack. {% endif %} @@ -79,7 +79,7 @@ You can use multiple operators in a tag: `contains` can also check for the presence of a string in an array of strings. ```liquid -{% raw %} +{%- raw -%} {% if product.tags contains "Hello" %} This product has been tagged with "Hello". {% endif %} @@ -93,7 +93,7 @@ You can use multiple operators in a tag: In tags with more than one `and` or `or` operator, operators are checked in order *from right to left*. You cannot change the order of operations using parentheses — parentheses are invalid characters in Liquid and will prevent your tags from working. ```liquid -{% raw %} +{%- raw -%} {% if true or false and false %} This evaluates to true, since the `and` condition is checked first. {% endif %} @@ -101,7 +101,7 @@ In tags with more than one `and` or `or` operator, operators are checked in orde ``` ```liquid -{% raw %} +{%- raw -%} {% if true and false and false or true %} This evaluates to false, since the tags are checked like this: diff --git a/_basics/truthy-and-falsy.md b/_basics/truthy-and-falsy.md index b1fffb979..492b7ad5e 100644 --- a/_basics/truthy-and-falsy.md +++ b/_basics/truthy-and-falsy.md @@ -3,47 +3,43 @@ title: Truthy and falsy description: An overview of boolean logic in the Liquid template language. --- -In programming, anything that returns `true` in a conditional is called **truthy**. Anything that returns `false` in a conditional is called **falsy**. All object types can be described as either truthy or falsy. - -- [Truthy](#truthy) -- [Falsy](#falsy) -- [Summary](#summary) +When a non-boolean [data type]({{ "/basics/types/" | prepend: site.baseurl }}) is used in a boolean context (such as a conditional tag), Liquid decides whether to evaluate it as `true` or `false`. Data types that return `true` by default are called **truthy**. Data types that return false by default are called **falsy**. ## Truthy All values in Liquid are truthy except `nil` and `false`. -In the example below, the string "Tobi" is not a boolean, but it is truthy in a conditional: +In the example below, the text "Tobi" is not a boolean, but it is truthy in a conditional: ```liquid -{% raw %} -{% assign tobi = "Tobi" %} +{%- raw -%} +{% assign name = "Tobi" %} -{% if tobi %} - This condition will always be true. +{% if name %} + This text will always appear since "name" is defined. {% endif %} {% endraw %} ``` -[Strings]({{ "/basics/types/#string" | prepend: site.baseurl }}), even when empty, are truthy. The example below will result in empty HTML tags if `settings.fp_heading` is empty: +[Strings]({{ "/basics/types/#string" | prepend: site.baseurl }}), even when empty, are truthy. The example below will create empty HTML tags if `page.category` exists but is empty:Input
```liquid -{% raw %} -{% if settings.fp_heading %} -Output
```html - + ``` ## Falsy -The falsy values in Liquid are [`nil`]({{ "/basics/types/#nil" | prepend: site.baseurl }}) and [`false`]({{ "/basics/types/#boolean" | prepend: site.baseurl }}). +The only values that are falsy in Liquid are [`nil`]({{ "/basics/types/#nil" | prepend: site.baseurl }}) and [`false`]({{ "/basics/types/#boolean" | prepend: site.baseurl }}). ## Summary diff --git a/_basics/types.md b/_basics/types.md index d7c6c7bf2..8c209af53 100644 --- a/_basics/types.md +++ b/_basics/types.md @@ -3,34 +3,37 @@ title: Types description: An overview of data types in the Liquid template language. --- -Liquid objects can have one of five types: +Liquid objects can be one of six types: - [String](#string) - [Number](#number) - [Boolean](#boolean) - [Nil](#nil) - [Array](#array) +- [EmptyDrop](#emptydrop) -You can initialize Liquid variables with the [assign]({{ "/tags/variable/#assign" | prepend: site.baseurl }}) or [capture]({{ "/tags/variable/#capture" | prepend: site.baseurl }}) tags. +You can initialize Liquid variables using [`assign`]({{ "/tags/variable/#assign" | prepend: site.baseurl }}) or [`capture`]({{ "/tags/variable/#capture" | prepend: site.baseurl }}) tags. ## String -Declare a string by wrapping a variable's value in single or double quotes: +Strings are sequences of characters wrapped in single or double quotes: ```liquid -{% raw %} +{%- raw -%} {% assign my_string = "Hello World!" %} {% endraw %} ``` +Liquid does not convert escape sequences into special characters. + ## Number Numbers include floats and integers: ```liquid -{% raw %} +{%- raw -%} {% assign my_int = 25 %} -{% assign my_float = 39.756 %} +{% assign my_float = -39.756 %} {% endraw %} ``` @@ -39,7 +42,7 @@ Numbers include floats and integers: Booleans are either `true` or `false`. No quotations are necessary when declaring a boolean: ```liquid -{% raw %} +{%- raw -%} {% assign foo = true %} {% assign bar = false %} {% endraw %} @@ -54,7 +57,7 @@ Nil is [treated as false]({{ "/basics/truthy-and-falsy/#falsy" | prepend: site.b In the following example, if the user does not exist (that is, `user` returns `nil`), Liquid will not print the greeting: ```liquid -{% raw %} +{%- raw -%} {% if user %} Hello {{ user.name }}! {% endif %} @@ -65,7 +68,7 @@ Tags or outputs that return `nil` will not print anything to the page.Input
```liquid -{% raw %} +{%- raw -%} The current user is {{ user.name }} {% endraw %} ``` @@ -85,7 +88,7 @@ To access all the items in an array, you can loop through each item in the arrayInput
```liquid -{% raw %} +{%- raw -%} {% for user in site.users %} {{ user }} @@ -95,20 +98,20 @@ To access all the items in an array, you can loop through each item in the arrayOutput
```text -Tobi Laura Tetsuro Adam + Tobi Laura Tetsuro Adam ``` ### Accessing specific items in arrays -You can use square bracket `[` `]` notation to access a specific item in an array. Array indexing starts at zero. +You can use square bracket `[` `]` notation to access a specific item in an array. Array indexing starts at zero. A negative index will count from the end of the array.Input
```liquid -{% raw %} +{%- raw -%} {{ site.users[0] }} {{ site.users[1] }} -{{ site.users[3] }} +{{ site.users[-1] }} {% endraw %} ``` @@ -123,4 +126,32 @@ Adam You cannot initialize arrays using only Liquid. -You can, however, use the [split]({{ "/filters/split/" | prepend: site.baseurl }}) filter to break a string into an array of substrings. +You can, however, use the [`split`]({{ "/filters/split/" | prepend: site.baseurl }}) filter to break a string into an array of substrings. + +## EmptyDrop + +An EmptyDrop object is returned if you try to access a deleted object. In the example below, `page_1`, `page_2` and `page_3` are all EmptyDrop objects: + +```liquid +{%- raw -%} +{% assign variable = "hello" %} +{% assign page_1 = pages[variable] %} +{% assign page_2 = pages["does-not-exist"] %} +{% assign page_3 = pages.this-handle-does-not-exist %} +{% endraw %} +``` + +### Checking for emptiness + +You can check to see if an object exists or not before you access any of its attributes. + +```liquid +{%- raw -%} +{% unless pages == empty %} +Input
```liquid -{% raw %} +{%- raw -%} {% assign my_variable = "tomato" %} {{ my_variable }} {% endraw %} @@ -23,29 +23,30 @@ Notice the blank line before "tomato" in the rendered template: {{ my_variable }} ``` -By including hyphens in your `assign` tag, you can strip the generated whitespace from the rendered template: +By including a hyphen in your `assign` closing delimiter, you can strip the whitespace following it from the rendered template:Input
```liquid -{% raw %} -{%- assign my_variable = "tomato" -%} +{%- raw -%} +{% assign my_variable = "tomato" -%} {{ my_variable }} {% endraw %} ```Output
```text -tomato +{% assign my_variable = "tomato" -%} +{{ my_variable }} ``` If you don't want any of your tags to print whitespace, as a general rule you can add hyphens to both sides of all your tags (`{% raw %}{%-{% endraw %}` and `{% raw %}-%}{% endraw %}`):Input
```liquid -{% raw %} +{%- raw -%} {% assign username = "John G. Chalmers-Smith" %} {% if username and username.size > 10 %} - Wow, {{ username }}, you have a long name! + Wow, {{ username }} , you have a long name! {% else %} Hello there! {% endif %} @@ -56,7 +57,7 @@ If you don't want any of your tags to print whitespace, as a general rule you ca ```text {% assign username = "John G. Chalmers-Smith" %} {% if username and username.size > 10 %} - Wow, {{ username }}, you have a long name! + Wow, {{ username }} , you have a long name! {% else %} Hello there! {% endif %} @@ -64,17 +65,22 @@ If you don't want any of your tags to print whitespace, as a general rule you caInput
```liquid -{% raw %} -{%- assign username = "John G. Chalmers-Smith" -%} +{%- raw -%} +{% assign username = "John G. Chalmers-Smith" -%} {%- if username and username.size > 10 -%} - Wow, {{ username }}, you have a long name! + Wow, {{ username -}} , you have a long name! {%- else -%} Hello there! -{%- endif -%} +{%- endif %} {% endraw %} ```Output with whitespace control
```text -Wow, John G. Chalmers-Smith, you have a long name! +{% assign username = "John G. Chalmers-Smith" -%} +{%- if username and username.size > 10 -%} + Wow, {{ username -}} , you have a long name! +{%- else -%} + Hello there! +{%- endif %} ``` diff --git a/_filters/abs.md b/_filters/abs.md index ee28e19bd..6763ecc23 100644 --- a/_filters/abs.md +++ b/_filters/abs.md @@ -8,33 +8,23 @@ Returns the absolute value of a number.Input
```liquid -{% raw %} +{%- raw -%} {{ -17 | abs }} -{% endraw %} -``` - -Output
-```text -{{ -17 | abs }} -``` - -Input
-```liquid -{% raw %} {{ 4 | abs }} {% endraw %} ```Output
```text +{{ -17 | abs }} {{ 4 | abs }} ``` -`abs` will also work on a string that only contains a number: +`abs` will also work on a string that only contains a number.Input
```liquid -{% raw %} +{%- raw -%} {{ "-19.86" | abs }} {% endraw %} ``` diff --git a/_filters/append.md b/_filters/append.md index 9c0bc1626..ab8356c9d 100644 --- a/_filters/append.md +++ b/_filters/append.md @@ -3,11 +3,11 @@ title: append description: Liquid filter that appends a string to another string. --- -Concatenates two strings and returns the concatenated value. +Adds the specified string to the end of another string.Input
```liquid -{% raw %} +{%- raw -%} {{ "/my/fancy/url" | append: ".html" }} {% endraw %} ``` @@ -17,11 +17,11 @@ Concatenates two strings and returns the concatenated value. {{ "/my/fancy/url" | append: ".html" }} ``` -`append` can also be used with variables: +`append` can also accept a variable as its argument.Input
```liquid -{% raw %} +{%- raw -%} {% assign filename = "/index.html" %} {{ "website.com" | append: filename }} {% endraw %} diff --git a/_filters/at_least.md b/_filters/at_least.md index 3bb2b141f..3f23b706c 100644 --- a/_filters/at_least.md +++ b/_filters/at_least.md @@ -1,30 +1,21 @@ --- title: at_least description: Liquid filter that limits a number to a minimum value. +version-badge: 4.0.1 --- Limits a number to a minimum value.Input
```liquid -{% raw %} +{%- raw -%} {{ 4 | at_least: 5 }} -{% endraw %} -``` - -Output
-```text -5 -``` - -Input
-```liquid -{% raw %} {{ 4 | at_least: 3 }} {% endraw %} ```Output
```text +5 4 ``` diff --git a/_filters/at_most.md b/_filters/at_most.md index 9599ee218..728e7960a 100644 --- a/_filters/at_most.md +++ b/_filters/at_most.md @@ -1,30 +1,21 @@ --- title: at_most description: Liquid filter that limits a number to a maximum value. +version-badge: 4.0.1 --- Limits a number to a maximum value.Input
```liquid -{% raw %} +{%- raw -%} {{ 4 | at_most: 5 }} -{% endraw %} -``` - -Output
-```text -4 -``` - -Input
-```liquid -{% raw %} {{ 4 | at_most: 3 }} {% endraw %} ```Output
```text +4 3 ``` diff --git a/_filters/capitalize.md b/_filters/capitalize.md index 72a461e34..99475e379 100644 --- a/_filters/capitalize.md +++ b/_filters/capitalize.md @@ -1,13 +1,13 @@ --- title: capitalize -description: Liquid filter that capitalizes the first character of a string. +description: Liquid filter that capitalizes the first character of a string and downcases the remaining characters. --- -Makes the first character of a string capitalized. +Makes the first character of a string capitalized and converts the remaining characters to lowercase.Input
```liquid -{% raw %} +{%- raw -%} {{ "title" | capitalize }} {% endraw %} ``` @@ -17,16 +17,16 @@ Makes the first character of a string capitalized. {{ "title" | capitalize }} ``` -`capitalize` only capitalizes the first character of a string, so later words are not affected: +Only the first character of a string is capitalized, so later words are not capitalized:Input
```liquid -{% raw %} -{{ "my great title" | capitalize }} +{%- raw -%} +{{ "my GREAT title" | capitalize }} {% endraw %} ```Output
```text -{{ "my great title" | capitalize }} +{{ "my GREAT title" | capitalize }} ``` diff --git a/_filters/ceil.md b/_filters/ceil.md index debc68881..80c67f3e0 100644 --- a/_filters/ceil.md +++ b/_filters/ceil.md @@ -3,41 +3,21 @@ title: ceil description: Liquid filter that returns the ceiling of a number by rounding up to the nearest integer. --- -Rounds the input up to the nearest whole number. Liquid tries to convert the input to a number before the filter is applied. +Rounds an input up to the nearest whole number. Liquid tries to convert the input to a number before the filter is applied.Input
```liquid -{% raw %} +{%- raw -%} {{ 1.2 | ceil }} -{% endraw %} -``` - -Output
-```text -{{ 1.2 | ceil }} -``` - -Input
-```liquid -{% raw %} -{{ 2.0 | ceil }} -{% endraw %} -``` - -Output
-```text {{ 2.0 | ceil }} -``` - -Input
-```liquid -{% raw %} {{ 183.357 | ceil }} {% endraw %} ```Output
```text +{{ 1.2 | ceil }} +{{ 2.0 | ceil }} {{ 183.357 | ceil }} ``` @@ -45,7 +25,7 @@ Here the input value is a string:Input
```liquid -{% raw %} +{%- raw -%} {{ "3.5" | ceil }} {% endraw %} ``` diff --git a/_filters/compact.md b/_filters/compact.md index 2847104e6..174339f42 100644 --- a/_filters/compact.md +++ b/_filters/compact.md @@ -1,6 +1,7 @@ --- title: compact description: Liquid filter that removes nil values from an array. +version-badge: 4.0.0 --- Removes any `nil` values from an array. @@ -9,7 +10,7 @@ For this example, assume `site.pages` is an array of content pages for a websiteInput
```liquid -{% raw %} +{%- raw -%} {% assign site_categories = site.pages | map: "category" %} {% for category in site_categories %} @@ -33,7 +34,7 @@ By using `compact` when we create our `site_categories` array, we can remove allInput
```liquid -{% raw %} +{%- raw -%} {% assign site_categories = site.pages | map: "category" | compact %} {% for category in site_categories %} diff --git a/_filters/concat.md b/_filters/concat.md index a41b60480..7ce565ad1 100644 --- a/_filters/concat.md +++ b/_filters/concat.md @@ -1,13 +1,14 @@ --- title: concat description: Liquid filter that concatenates arrays. +version-badge: 4.0.0 --- Concatenates (joins together) multiple arrays. The resulting array contains all the items from the input arrays.Input
```liquid -{% raw %} +{%- raw -%} {% assign fruits = "apples, oranges, peaches" | split: ", " %} {% assign vegetables = "carrots, turnips, potatoes" | split: ", " %} @@ -29,11 +30,11 @@ Concatenates (joins together) multiple arrays. The resulting array contains all - potatoes ``` -You can string together `concat` filters to join more than two arrays: +You can string together multiple `concat` filters to join more than two arrays.Input
```liquid -{% raw %} +{%- raw -%} {% assign furniture = "chairs, tables, shelves" | split: ", " %} {% assign everything = fruits | concat: vegetables | concat: furniture %} diff --git a/_filters/date.md b/_filters/date.md index 69be3ec37..cc0b79f18 100644 --- a/_filters/date.md +++ b/_filters/date.md @@ -7,7 +7,7 @@ Converts a timestamp into another date format. The format for this syntax is theInput
```liquid -{% raw %} +{%- raw -%} {{ article.published_at | date: "%a, %b %d, %y" }} {% endraw %} ``` @@ -19,7 +19,7 @@ Fri, Jul 17, 15Input
```liquid -{% raw %} +{%- raw -%} {{ article.published_at | date: "%Y" }} {% endraw %} ``` @@ -29,11 +29,11 @@ Fri, Jul 17, 15 2015 ``` -`date` works on strings if they contain well-formatted dates: +`date` works on strings if they contain well-formatted dates.Input
```liquid -{% raw %} +{%- raw -%} {{ "March 14, 2016" | date: "%b %d, %y" }} {% endraw %} ``` @@ -43,11 +43,11 @@ Fri, Jul 17, 15 {{ "March 14, 2016" | date: "%b %d, %y" }} ``` -To get the current time, pass the special word `"now"` (or `"today"`) to `date`: +To get the current time, pass the special word `"now"` (or `"today"`) to `date`.Input
```liquid -{% raw %} +{%- raw -%} This page was last updated at {{ "now" | date: "%Y-%m-%d %H:%M" }}. {% endraw %} ``` diff --git a/_filters/default.md b/_filters/default.md index 9437cd507..9231b85b1 100644 --- a/_filters/default.md +++ b/_filters/default.md @@ -3,27 +3,27 @@ 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. +Sets a default value for any variable with no assigned value. `default` will show its value if the input is `nil`, `false`, or empty. In this example, `product_price` is not defined, so the default value is used.Input
```liquid -{% raw %} +{%- raw -%} {{ product_price | default: 2.99 }} {% endraw %} ```Output
```text -2.99 +{{ product_price | default: 2.99 }} ``` In this example, `product_price` is defined, so the default value is not used.Input
```liquid -{% raw %} +{%- raw -%} {% assign product_price = 4.99 %} {{ product_price | default: 2.99 }} {% endraw %} @@ -31,14 +31,15 @@ In this example, `product_price` is defined, so the default value is not used.Output
```text -4.99 +{% assign product_price = 4.99 %} +{{ product_price | default: 2.99 }} ``` In this example, `product_price` is empty, so the default value is used.Input
```liquid -{% raw %} +{%- raw -%} {% assign product_price = "" %} {{ product_price | default: 2.99 }} {% endraw %} @@ -46,5 +47,24 @@ In this example, `product_price` is empty, so the default value is used.Output
```text -2.99 +{% assign product_price = "" %} +{{ product_price | default: 2.99 }} +``` + +### Allowing `false` {%- include version-badge.html version="5.0.0" %} + +To allow variables to return `false` instead of the default value, you can use the `allow_false` parameter. + +Input
+```liquid +{%- raw -%} +{% assign display_price = false %} +{{ display_price | default: true, allow_false: true }} +{% endraw %} +``` + +Output
+```text + +false ``` diff --git a/_filters/divided_by.md b/_filters/divided_by.md index f87d9b19b..72c83db54 100644 --- a/_filters/divided_by.md +++ b/_filters/divided_by.md @@ -9,25 +9,15 @@ The result is rounded down to the nearest integer (that is, the [floor]({{ "/filInput
```liquid -{% raw %} +{%- raw -%} {{ 16 | divided_by: 4 }} -{% endraw %} -``` - -Output
-```text -{{ 16 | divided_by: 4 }} -``` - -Input
-```liquid -{% raw %} {{ 5 | divided_by: 3 }} {% endraw %} ```Output
```text +{{ 16 | divided_by: 4 }} {{ 5 | divided_by: 3 }} ``` @@ -39,7 +29,7 @@ For example, here the divisor is an integer:Input
```liquid -{% raw %} +{%- raw -%} {{ 20 | divided_by: 7 }} {% endraw %} ``` @@ -53,7 +43,7 @@ Here it is a float:Input
```liquid -{% raw %} +{%- raw -%} {{ 20 | divided_by: 7.0 }} {% endraw %} ``` @@ -71,7 +61,7 @@ In this example, we're dividing by a variable that contains an integer, so we geInput
```liquid -{% raw %} +{%- raw -%} {% assign my_integer = 7 %} {{ 20 | divided_by: my_integer }} {% endraw %} @@ -87,7 +77,7 @@ Here, we [multiply]({{ "/filters/times/" | prepend: site.baseurl }}) the variablInput
```liquid -{% raw %} +{%- raw -%} {% assign my_integer = 7 %} {% assign my_float = my_integer | times: 1.0 %} {{ 20 | divided_by: my_float }} diff --git a/_filters/downcase.md b/_filters/downcase.md index e66239efb..e73212767 100644 --- a/_filters/downcase.md +++ b/_filters/downcase.md @@ -7,7 +7,7 @@ Makes each character in a string lowercase. It has no effect on strings which arInput
```liquid -{% raw %} +{%- raw -%} {{ "Parker Moore" | downcase }} {% endraw %} ``` @@ -19,7 +19,7 @@ Makes each character in a string lowercase. It has no effect on strings which arInput
```liquid -{% raw %} +{%- raw -%} {{ "apple" | downcase }} {% endraw %} ``` diff --git a/_filters/escape.md b/_filters/escape.md index 479325b5f..1a7db6119 100644 --- a/_filters/escape.md +++ b/_filters/escape.md @@ -7,7 +7,7 @@ Escapes a string by replacing characters with escape sequences (so that the striInput
```liquid -{% raw %} +{%- raw -%} {{ "Have you read 'James & the Giant Peach'?" | escape }} {% endraw %} ``` @@ -19,7 +19,7 @@ Escapes a string by replacing characters with escape sequences (so that the striInput
```liquid -{% raw %} +{%- raw -%} {{ "Tetsuro Takara" | escape }} {% endraw %} ``` diff --git a/_filters/escape_once.md b/_filters/escape_once.md index 6ee787ec0..1aa358b24 100644 --- a/_filters/escape_once.md +++ b/_filters/escape_once.md @@ -7,7 +7,7 @@ Escapes a string without changing existing escaped entities. It doesn't change sInput
```liquid -{% raw %} +{%- raw -%} {{ "1 < 2 & 3" | escape_once }} {% endraw %} ``` @@ -19,7 +19,7 @@ Escapes a string without changing existing escaped entities. It doesn't change sInput
```liquid -{% raw %} +{%- raw -%} {{ "1 < 2 & 3" | escape_once }} {% endraw %} ``` diff --git a/_filters/first.md b/_filters/first.md index a5345975b..386975da9 100644 --- a/_filters/first.md +++ b/_filters/first.md @@ -7,7 +7,7 @@ Returns the first item of an array.Input
```liquid -{% raw %} +{%- raw -%} {{ "Ground control to Major Tom." | split: " " | first }} {% endraw %} ``` @@ -19,7 +19,7 @@ Returns the first item of an array.Input
```liquid -{% raw %} +{%- raw -%} {% assign my_array = "zebra, octopus, giraffe, tiger" | split: ", " %} {{ my_array.first }} @@ -36,7 +36,7 @@ Returns the first item of an array. You can use `first` with dot notation when you need to use the filter inside a tag: ```liquid -{% raw %} +{%- raw -%} {% if my_array.first == "zebra" %} Here comes a zebra! {% endif %} diff --git a/_filters/floor.md b/_filters/floor.md index 1b1269784..70ea9c9b1 100644 --- a/_filters/floor.md +++ b/_filters/floor.md @@ -3,41 +3,21 @@ title: floor description: Liquid filter that returns the floor of a number by rounding down to the nearest integer. --- -Rounds the input down to the nearest whole number. Liquid tries to convert the input to a number before the filter is applied. +Rounds an input down to the nearest whole number. Liquid tries to convert the input to a number before the filter is applied.Input
```liquid -{% raw %} +{%- raw -%} {{ 1.2 | floor }} -{% endraw %} -``` - -Output
-```text -{{ 1.2 | floor }} -``` - -Input
-```liquid -{% raw %} -{{ 2.0 | floor }} -{% endraw %} -``` - -Output
-```text {{ 2.0 | floor }} -``` - -Input
-```liquid -{% raw %} {{ 183.357 | floor }} {% endraw %} ```Output
```text +{{ 1.2 | floor }} +{{ 2.0 | floor }} {{ 183.357 | floor }} ``` @@ -45,7 +25,7 @@ Here the input value is a string:Input
```liquid -{% raw %} +{%- raw -%} {{ "3.5" | floor }} {% endraw %} ``` diff --git a/_filters/join.md b/_filters/join.md index 2cd589ce3..1e3391bce 100644 --- a/_filters/join.md +++ b/_filters/join.md @@ -7,7 +7,7 @@ Combines the items in an array into a single string using the argument as a sepaInput
```liquid -{% raw %} +{%- raw -%} {% assign beatles = "John, Paul, George, Ringo" | split: ", " %} {{ beatles | join: " and " }} diff --git a/_filters/last.md b/_filters/last.md index 5337abbed..7d3c911f1 100644 --- a/_filters/last.md +++ b/_filters/last.md @@ -7,7 +7,7 @@ Returns the last item of an array.Input
```liquid -{% raw %} +{%- raw -%} {{ "Ground control to Major Tom." | split: " " | last }} {% endraw %} ``` @@ -19,7 +19,7 @@ Returns the last item of an array.Input
```liquid -{% raw %} +{%- raw -%} {% assign my_array = "zebra, octopus, giraffe, tiger" | split: ", " %} {{ my_array.last }} @@ -36,7 +36,7 @@ Returns the last item of an array. You can use `last` with dot notation when you need to use the filter inside a tag: ```liquid -{% raw %} +{%- raw -%} {% if my_array.last == "tiger" %} There goes a tiger! {% endif %} diff --git a/_filters/lstrip.md b/_filters/lstrip.md index c9b929402..df7ec6ead 100644 --- a/_filters/lstrip.md +++ b/_filters/lstrip.md @@ -3,16 +3,16 @@ title: lstrip description: Liquid filter that removes all whitespace from the left side of a string. --- -Removes all whitespace (tabs, spaces, and newlines) from the left side of a string. It does not affect spaces between words. +Removes all whitespace (tabs, spaces, and newlines) from the **left** side of a string. It does not affect spaces between words.Input
```liquid -{% raw %} -{{ " So much room for activities! " | lstrip }} +{%- raw -%} +{{ " So much room for activities " | lstrip }}! {% endraw %} ```Output
```text -{{ " So much room for activities! " | lstrip }} +{{ " So much room for activities " | lstrip }}! ``` diff --git a/_filters/map.md b/_filters/map.md index ddeff2014..62e754d83 100644 --- a/_filters/map.md +++ b/_filters/map.md @@ -9,7 +9,7 @@ In this example, assume the object `site.pages` contains all the metadata for aInput
```liquid -{% raw %} +{%- raw -%} {% assign all_categories = site.pages | map: "category" %} {% for item in all_categories %} diff --git a/_filters/minus.md b/_filters/minus.md index d1f65b5a2..53232939a 100644 --- a/_filters/minus.md +++ b/_filters/minus.md @@ -7,36 +7,16 @@ Subtracts a number from another number.Input
```liquid -{% raw %} +{%- raw -%} {{ 4 | minus: 2 }} -{% endraw %} -``` - -Output
-```text -{{ 4 | minus: 2 }} -``` - -Input
-```liquid -{% raw %} -{{ 16 | minus: 4 }} -{% endraw %} -``` - -Output
-```text {{ 16 | minus: 4 }} -``` - -Input
-```liquid -{% raw %} {{ 183.357 | minus: 12 }} {% endraw %} ```Output
```text +{{ 4 | minus: 2 }} +{{ 16 | minus: 4 }} {{ 183.357 | minus: 12 }} ``` diff --git a/_filters/modulo.md b/_filters/modulo.md index 17e79bc35..b0de01a02 100644 --- a/_filters/modulo.md +++ b/_filters/modulo.md @@ -7,36 +7,16 @@ Returns the remainder of a division operation.Input
```liquid -{% raw %} +{%- raw -%} {{ 3 | modulo: 2 }} -{% endraw %} -``` - -Output
-```text -{{ 3 | modulo: 2 }} -``` - -Input
-```liquid -{% raw %} -{{ 24 | modulo: 7 }} -{% endraw %} -``` - -Output
-```text {{ 24 | modulo: 7 }} -``` - -Input
-```liquid -{% raw %} {{ 183.357 | modulo: 12 }} {% endraw %} ```Output
```text +{{ 3 | modulo: 2 }} +{{ 24 | modulo: 7 }} {{ 183.357 | modulo: 12 }} ``` diff --git a/_filters/newline_to_br.md b/_filters/newline_to_br.md index 89b280d09..70b197451 100644 --- a/_filters/newline_to_br.md +++ b/_filters/newline_to_br.md @@ -3,11 +3,11 @@ title: newline_to_br description: Liquid filter that converts newlines in a string to HTMLInput
```liquid -{% raw %} +{%- raw -%} {% capture string_with_newlines %} Hello there diff --git a/_filters/plus.md b/_filters/plus.md index 110022054..039f22189 100644 --- a/_filters/plus.md +++ b/_filters/plus.md @@ -7,36 +7,16 @@ Adds a number to another number.Input
```liquid -{% raw %} +{%- raw -%} {{ 4 | plus: 2 }} -{% endraw %} -``` - -Output
-```text -{{ 4 | plus: 2 }} -``` - -Input
-```liquid -{% raw %} -{{ 16 | plus: 4 }} -{% endraw %} -``` - -Output
-```text {{ 16 | plus: 4 }} -``` - -Input
-```liquid -{% raw %} {{ 183.357 | plus: 12 }} {% endraw %} ```Output
```text +{{ 4 | plus: 2 }} +{{ 16 | plus: 4 }} {{ 183.357 | plus: 12 }} ``` diff --git a/_filters/prepend.md b/_filters/prepend.md index 5df4708ba..6d39521e3 100644 --- a/_filters/prepend.md +++ b/_filters/prepend.md @@ -7,7 +7,7 @@ Adds the specified string to the beginning of another string.Input
```liquid -{% raw %} +{%- raw -%} {{ "apples, oranges, and bananas" | prepend: "Some fruit: " }} {% endraw %} ``` @@ -17,11 +17,11 @@ Adds the specified string to the beginning of another string. {{ "apples, oranges, and bananas" | prepend: "Some fruit: " }} ``` -`prepend` can also be used with variables: +`prepend` can also accept a variable as its argument.Input
```liquid -{% raw %} +{%- raw -%} {% assign url = "example.com" %} {{ "/index.html" | prepend: url }} {% endraw %} diff --git a/_filters/remove.md b/_filters/remove.md index 0a294abac..8349b0b6e 100644 --- a/_filters/remove.md +++ b/_filters/remove.md @@ -7,7 +7,7 @@ Removes every occurrence of the specified substring from a string.Input
```liquid -{% raw %} +{%- raw -%} {{ "I strained to see the train through the rain" | remove: "rain" }} {% endraw %} ``` diff --git a/_filters/remove_first.md b/_filters/remove_first.md index ead16b95e..4c659171f 100644 --- a/_filters/remove_first.md +++ b/_filters/remove_first.md @@ -7,7 +7,7 @@ Removes only the first occurrence of the specified substring from a string.Input
```liquid -{% raw %} +{%- raw -%} {{ "I strained to see the train through the rain" | remove_first: "rain" }} {% endraw %} ``` diff --git a/_filters/replace.md b/_filters/replace.md index aba612f97..3fde134b6 100644 --- a/_filters/replace.md +++ b/_filters/replace.md @@ -7,7 +7,7 @@ Replaces every occurrence of the first argument in a string with the second arguInput
```liquid -{% raw %} +{%- raw -%} {{ "Take my protein pills and put my helmet on" | replace: "my", "your" }} {% endraw %} ``` diff --git a/_filters/replace_first.md b/_filters/replace_first.md index c25ee3ac8..5c46ac431 100644 --- a/_filters/replace_first.md +++ b/_filters/replace_first.md @@ -7,7 +7,7 @@ Replaces only the first occurrence of the first argument in a string with the seInput
```liquid -{% raw %} +{%- raw -%} {{ "Take my protein pills and put my helmet on" | replace_first: "my", "your" }} {% endraw %} ``` diff --git a/_filters/reverse.md b/_filters/reverse.md index 3832f67c2..b7d88bc68 100644 --- a/_filters/reverse.md +++ b/_filters/reverse.md @@ -7,7 +7,7 @@ Reverses the order of the items in an array. `reverse` cannot reverse a string.Input
```liquid -{% raw %} +{%- raw -%} {% assign my_array = "apples, oranges, peaches, plums" | split: ", " %} {{ my_array | reverse | join: ", " }} @@ -21,11 +21,11 @@ Reverses the order of the items in an array. `reverse` cannot reverse a string. {{ my_array | reverse | join: ", " }} ``` -Although `reverse` cannot be used directly on a string, you can split a string into an array, reverse the array, and rejoin it by chaining together filters: +Although `reverse` cannot be used directly on a string, you can split a string into an array, reverse the array, and rejoin it by chaining together filters.Input
```liquid -{% raw %} +{%- raw -%} {{ "Ground control to Major Tom." | split: "" | reverse | join: "" }} {% endraw %} ``` diff --git a/_filters/round.md b/_filters/round.md index d95c4fa77..6eb2e655a 100644 --- a/_filters/round.md +++ b/_filters/round.md @@ -7,36 +7,16 @@ Rounds a number to the nearest integer or, if a number is passed as an argument,Input
```liquid -{% raw %} +{%- raw -%} {{ 1.2 | round }} -{% endraw %} -``` - -Output
-```text -{{ 1.2 | round }} -``` - -Input
-```liquid -{% raw %} -{{ 2.7 | round }} -{% endraw %} -``` - -Output
-```text {{ 2.7 | round }} -``` - -Input
-```liquid -{% raw %} {{ 183.357 | round: 2 }} {% endraw %} ```Output
```text +{{ 1.2 | round }} +{{ 2.7 | round }} {{ 183.357 | round: 2 }} ``` diff --git a/_filters/rstrip.md b/_filters/rstrip.md index 25e64f266..5226dd977 100644 --- a/_filters/rstrip.md +++ b/_filters/rstrip.md @@ -3,16 +3,16 @@ title: rstrip description: Liquid filter that removes all whitespace from the right side of a string. --- -Removes all whitespace (tabs, spaces, and newlines) from the right side of a string. It does not affect spaces between words. +Removes all whitespace (tabs, spaces, and newlines) from the **right** side of a string. It does not affect spaces between words.Input
```liquid -{% raw %} -{{ " So much room for activities! " | rstrip }} +{%- raw -%} +{{ " So much room for activities " | rstrip }}! {% endraw %} ```Output
```text -{{ " So much room for activities! " | rstrip }} +{{ " So much room for activities " | rstrip }}! ``` diff --git a/_filters/size.md b/_filters/size.md index 96d8a096a..4d50dfc58 100644 --- a/_filters/size.md +++ b/_filters/size.md @@ -7,7 +7,7 @@ Returns the number of characters in a string or the number of items in an array.Input
```liquid -{% raw %} +{%- raw -%} {{ "Ground control to Major Tom." | size }} {% endraw %} ``` @@ -19,7 +19,7 @@ Returns the number of characters in a string or the number of items in an array.Input
```liquid -{% raw %} +{%- raw -%} {% assign my_array = "apples, oranges, peaches, plums" | split: ", " %} {{ my_array.size }} @@ -36,7 +36,7 @@ Returns the number of characters in a string or the number of items in an array. You can use `size` with dot notation when you need to use the filter inside a tag: ```liquid -{% raw %} +{%- raw -%} {% if site.pages.size > 10 %} This is a big website! {% endif %} diff --git a/_filters/slice.md b/_filters/slice.md index eeb1bb8a0..2f6c70482 100644 --- a/_filters/slice.md +++ b/_filters/slice.md @@ -1,15 +1,15 @@ --- title: slice -description: Liquid filter that returns a substring from a given position in a string. +description: Liquid filter that returns a substring or item from a given position in a string or array. --- -Returns a substring of 1 character beginning at the index specified by the first argument. An optional second argument specifies the length of the substring to be returned. +Returns a substring of one character or series of array items beginning at the index specified by the first argument. An optional second argument specifies the length of the substring or number of array items to be returned. -String indices are numbered starting from 0. +String or array indices are numbered starting from 0.Input
```liquid -{% raw %} +{%- raw -%} {{ "Liquid" | slice: 0 }} {% endraw %} ``` @@ -21,7 +21,7 @@ String indices are numbered starting from 0.Input
```liquid -{% raw %} +{%- raw -%} {{ "Liquid" | slice: 2 }} {% endraw %} ``` @@ -33,7 +33,7 @@ String indices are numbered starting from 0.Input
```liquid -{% raw %} +{%- raw -%} {{ "Liquid" | slice: 2, 5 }} {% endraw %} ``` @@ -43,11 +43,27 @@ String indices are numbered starting from 0. {{ "Liquid" | slice: 2, 5 }} ``` -If the first argument is a negative number, the indices are counted from the end of the string: +Here the input value is an array:Input
```liquid -{% raw %} +{%- raw -%} +{% assign beatles = "John, Paul, George, Ringo" | split: ", " %} +{{ beatles | slice: 1, 2 }} +{% endraw %} +``` + +Output
+```text +{% assign beatles = "John, Paul, George, Ringo" | split: ", " %} +{{ beatles | slice: 1, 2 }} +``` + +If the first argument is a negative number, the indices are counted from the end of the string. + +Input
+```liquid +{%- raw -%} {{ "Liquid" | slice: -3, 2 }} {% endraw %} ``` diff --git a/_filters/sort.md b/_filters/sort.md index f890d5cef..72f0a9998 100644 --- a/_filters/sort.md +++ b/_filters/sort.md @@ -7,7 +7,7 @@ Sorts items in an array in case-sensitive order.Input
```liquid -{% raw %} +{%- raw -%} {% assign my_array = "zebra, octopus, giraffe, Sally Snake" | split: ", " %} {{ my_array | sort | join: ", " }} @@ -24,7 +24,7 @@ Sorts items in an array in case-sensitive order. An optional argument specifies which property of the array's items to use for sorting. ```liquid -{% raw %} +{%- raw -%} {% assign products_by_price = collection.products | sort: "price" %} {% for product in products_by_price %}Input
```liquid -{% raw %} +{%- raw -%} {% assign my_array = "zebra, octopus, giraffe, Sally Snake" | split: ", " %} {{ my_array | sort_natural | join: ", " }} @@ -24,7 +25,7 @@ Sorts items in an array in case-insensitive order. An optional argument specifies which property of the array's items to use for sorting. ```liquid -{% raw %} +{%- raw -%} {% assign products_by_company = collection.products | sort_natural: "company" %} {% for product in products_by_company %}Input
```liquid -{% raw %} +{%- raw -%} {% assign beatles = "John, Paul, George, Ringo" | split: ", " %} {% for member in beatles %} diff --git a/_filters/strip.md b/_filters/strip.md index 3efdad252..a79816a63 100644 --- a/_filters/strip.md +++ b/_filters/strip.md @@ -7,12 +7,12 @@ Removes all whitespace (tabs, spaces, and newlines) from both the left and rightInput
```liquid -{% raw %} -{{ " So much room for activities! " | strip }} +{%- raw -%} +{{ " So much room for activities " | strip }}! {% endraw %} ```Output
```text -{{ " So much room for activities! " | strip }} +{{ " So much room for activities " | strip }}! ``` diff --git a/_filters/strip_html.md b/_filters/strip_html.md index 9ca00f086..88425993b 100644 --- a/_filters/strip_html.md +++ b/_filters/strip_html.md @@ -7,7 +7,7 @@ Removes any HTML tags from a string.Input
```liquid -{% raw %} +{%- raw -%} {{ "Have you read Ulysses?" | strip_html }} {% endraw %} ``` diff --git a/_filters/strip_newlines.md b/_filters/strip_newlines.md index c05deaa36..0a2324bb2 100644 --- a/_filters/strip_newlines.md +++ b/_filters/strip_newlines.md @@ -7,7 +7,7 @@ Removes any newline characters (line breaks) from a string.Input
```liquid -{% raw %} +{%- raw -%} {% capture string_with_newlines %} Hello there diff --git a/_filters/times.md b/_filters/times.md index 634c7e49d..90c2757a4 100644 --- a/_filters/times.md +++ b/_filters/times.md @@ -7,36 +7,16 @@ Multiplies a number by another number.Input
```liquid -{% raw %} +{%- raw -%} {{ 3 | times: 2 }} -{% endraw %} -``` - -Output
-```text -{{ 3 | times: 2 }} -``` - -Input
-```liquid -{% raw %} -{{ 24 | times: 7 }} -{% endraw %} -``` - -Output
-```text {{ 24 | times: 7 }} -``` - -Input
-```liquid -{% raw %} {{ 183.357 | times: 12 }} {% endraw %} ```Output
```text +{{ 3 | times: 2 }} +{{ 24 | times: 7 }} {{ 183.357 | times: 12 }} ``` diff --git a/_filters/truncate.md b/_filters/truncate.md index c0b0a4e39..0881fb08f 100644 --- a/_filters/truncate.md +++ b/_filters/truncate.md @@ -7,7 +7,7 @@ Shortens a string down to the number of characters passed as an argument. If theInput
```liquid -{% raw %} +{%- raw -%} {{ "Ground control to Major Tom." | truncate: 20 }} {% endraw %} ``` @@ -25,7 +25,7 @@ The length of the second argument counts against the number of characters specifInput
```liquid -{% raw %} +{%- raw -%} {{ "Ground control to Major Tom." | truncate: 25, ", and so on" }} {% endraw %} ``` @@ -37,11 +37,11 @@ The length of the second argument counts against the number of characters specif ### No ellipsis -You can truncate to the exact number of characters specified by the first argument and avoid showing trailing characters by passing a blank string as the second argument: +You can truncate to the exact number of characters specified by the first argument and avoid showing trailing characters by passing a blank string as the second argument.Input
```liquid -{% raw %} +{%- raw -%} {{ "Ground control to Major Tom." | truncate: 20, "" }} {% endraw %} ``` diff --git a/_filters/truncatewords.md b/_filters/truncatewords.md index 6d5c5ab1a..5cc57a5b6 100644 --- a/_filters/truncatewords.md +++ b/_filters/truncatewords.md @@ -7,7 +7,7 @@ Shortens a string down to the number of words passed as an argument. If the specInput
```liquid -{% raw %} +{%- raw -%} {{ "Ground control to Major Tom." | truncatewords: 3 }} {% endraw %} ``` @@ -23,7 +23,7 @@ Shortens a string down to the number of words passed as an argument. If the specInput
```liquid -{% raw %} +{%- raw -%} {{ "Ground control to Major Tom." | truncatewords: 3, "--" }} {% endraw %} ``` @@ -35,11 +35,11 @@ Shortens a string down to the number of words passed as an argument. If the spec ### No ellipsis -You can avoid showing trailing characters by passing a blank string as the second argument: +You can avoid showing trailing characters by passing a blank string as the second argument.Input
```liquid -{% raw %} +{%- raw -%} {{ "Ground control to Major Tom." | truncatewords: 3, "" }} {% endraw %} ``` diff --git a/_filters/uniq.md b/_filters/uniq.md index e02b4e9d2..0f87b5ccb 100644 --- a/_filters/uniq.md +++ b/_filters/uniq.md @@ -3,11 +3,11 @@ title: uniq description: Liquid filter that removes duplicate items from an array. --- -Removes any duplicate elements in an array. +Removes any duplicate items in an array.Input
```liquid -{% raw %} +{%- raw -%} {% assign my_array = "ants, bugs, bees, bugs, ants" | split: ", " %} {{ my_array | uniq | join: ", " }} diff --git a/_filters/upcase.md b/_filters/upcase.md index 627853723..d131b43c5 100644 --- a/_filters/upcase.md +++ b/_filters/upcase.md @@ -7,7 +7,7 @@ Makes each character in a string uppercase. It has no effect on strings which arInput
```liquid -{% raw %} +{%- raw -%} {{ "Parker Moore" | upcase }} {% endraw %} ``` @@ -19,7 +19,7 @@ Makes each character in a string uppercase. It has no effect on strings which arInput
```liquid -{% raw %} +{%- raw -%} {{ "APPLE" | upcase }} {% endraw %} ``` diff --git a/_filters/url_decode.md b/_filters/url_decode.md index bf240c194..e5559c932 100644 --- a/_filters/url_decode.md +++ b/_filters/url_decode.md @@ -1,13 +1,14 @@ --- title: url_decode description: Liquid filter that decodes percent-encoded characters in a string. +version-badge: 4.0.0 --- -Decodes a string that has been encoded as a URL or by [url_encode]({{ "/filters/url_encode/" | prepend: site.baseurl }}). +Decodes a string that has been encoded as a URL or by [`url_encode`]({{ "/filters/url_encode/" | prepend: site.baseurl }}).Input
```liquid -{% raw %} +{%- raw -%} {{ "%27Stop%21%27+said+Fred" | url_decode }} {% endraw %} ``` diff --git a/_filters/url_encode.md b/_filters/url_encode.md index 5a17c8130..74fe92935 100644 --- a/_filters/url_encode.md +++ b/_filters/url_encode.md @@ -7,7 +7,7 @@ Converts any URL-unsafe characters in a string into percent-encoded characters.Input
```liquid -{% raw %} +{%- raw -%} {{ "john@liquid.com" | url_encode }} {% endraw %} ``` @@ -17,9 +17,11 @@ Converts any URL-unsafe characters in a string into percent-encoded characters. {{ "john@liquid.com" | url_encode }} ``` +Note that `url_encode` will turn a space into a `+` sign instead of a percent-encoded character. +Input
```liquid -{% raw %} +{%- raw -%} {{ "Tetsuro Takara" | url_encode }} {% endraw %} ``` diff --git a/_filters/where.md b/_filters/where.md index 70f797f03..80d800426 100644 --- a/_filters/where.md +++ b/_filters/where.md @@ -1,6 +1,7 @@ --- title: where description: Liquid filter that selects from arrays. +version-badge: 4.0.2 --- Creates an array including only the objects with a given property value, or any [truthy]({{ "/basics/truthy-and-falsy/#truthy" | prepend: site.baseurl }}) value by default. @@ -9,7 +10,7 @@ In this example, assume you have a list of products and you want to show your kiInput
```liquid -{% raw %} +{%- raw -%} All products: {% for product in products %} - {{ product.title }} @@ -41,7 +42,7 @@ Say instead you have a list of products and you only want to show those that areInput
```liquid -{% raw %} +{%- raw -%} All products: {% for product in products %} - {{ product.title }} @@ -72,7 +73,7 @@ The `where` filter can also be used to find a single object in an array when comInput
```liquid -{% raw %} +{%- raw -%} {% assign new_shirt = products | where: "type", "shirt" | first %} Featured product: {{ new_shirt.title }} diff --git a/_includes/sidebar.html b/_includes/sidebar.html index c25858267..b2b979a5f 100644 --- a/_includes/sidebar.html +++ b/_includes/sidebar.html @@ -12,7 +12,7 @@