Compare commits

..
Author SHA1 Message Date
Adam Hollett 2360370d19 Remove water droplet icon for now 2016-11-30 08:44:59 -05:00
Adam Hollett b86226c2f6 SVG optimization and CSS fixes 2016-11-14 09:04:38 -05:00
Adam Hollett f62a3b26fc Mention GitHub Pages 2016-11-09 10:12:12 -05:00
Adam Hollett 5ffb286353 templating -> template 2016-11-09 10:06:22 -05:00
Adam Hollett cacfe95c59 Add page outlining the most common variants of Liquid 2016-11-09 10:05:54 -05:00
Adam Hollett 1fe6b24d47 Add descriptions for remaining pages 2016-11-09 09:11:47 -05:00
Adam Hollett d4d3d1a8e7 Delete tags aggregate index, remove hidden theme tags page 2016-11-09 09:11:38 -05:00
Adam Hollett fd98f82a07 Bump jQuery, fix emoji CSS 2016-11-09 09:02:51 -05:00
Adam Hollett 4e42b08f3c Add favicon and better metadata 2016-11-08 17:23:36 -05:00
Adam Hollett aef8bd5642 Fix up miscellaneous things and remove some deps 2016-11-08 16:23:33 -05:00
Justin LiandGitHub aa35b3f3fd Merge pull request #813 from kainjow/patch-1
Update iteration.md
2016-10-26 18:53:27 -04:00
Kevin WojniakandGitHub 295bdf3fa8 Update iteration.md
Fix liquid syntax error

Liquid Warning: Liquid syntax error (line 111): Unexpected character   in "i in (3..5) " in tags/iteration.md
2016-10-26 14:16:17 -07:00
Justin LiandGitHub 16f0580d33 Merge pull request #810 from knu/patch-1
Document how to get the current time
2016-10-23 10:35:44 -04:00
Akinori MUSHA 0ecaecc889 Document how to get the current time 2016-10-23 22:42:23 +09:00
Adam HollettandGitHub 8b07f4b059 Merge pull request #785 from Shopify/whitespace-control-docs
Add page on whitespace control tags
2016-08-12 08:58:33 -04:00
Adam Hollett 98d098f060 Add page on whitespace control tags 2016-08-11 10:08:24 -04:00
Adam HollettandGitHub 05c5d2a12d Merge pull request #781 from MilanAryal/patch-1
Add http for strftime site
2016-07-20 10:32:37 -04:00
Milan AryalandGitHub e97ee306d8 Add http for strftime site 2016-07-20 11:42:49 +05:45
Adam HollettandGitHub 461db01257 Merge pull request #766 from Shopify/multiplication-and-division
Better explanation of divided_by filter
2016-06-15 10:48:35 -04:00
Adam Hollett 20562fb32a Markdown linting 2016-06-15 10:02:56 -04:00
Adam Hollett 1e093f9cb6 Remove errant colon 2016-06-15 10:00:24 -04:00
Adam Hollett bda77bc934 Better explanation of divided_by filter 2016-06-15 09:56:06 -04:00
Adam Hollett 55bded5041 Prepend page links with baseurl 2016-06-14 16:27:18 -04:00
Adam HollettandGitHub 4fdb21e0ea Merge pull request #765 from Shopify/collection-index-pages
Generate index pages for tags and filters
2016-06-14 15:15:37 -04:00
Adam Hollett c2ead29ff9 Generate index pages for tags and filters 2016-06-14 11:04:31 -04:00
Adam HollettandGitHub 8590bb5727 Merge pull request #764 from Shopify/truncate-filter-parameters
Examples for second parameter of truncate
2016-06-13 16:00:20 -04:00
Adam Hollett d849a9e010 Examples for second parameter of truncate 2016-06-13 12:58:30 -04:00
Adam Hollett 6fc28fcf2e Fix typo 2016-06-07 15:43:03 -04:00
Matt Vleming 75556460f0 Delete CNAME 2016-05-12 15:45:52 -04:00
tetchi 80f6f04132 Merge pull request #741 from Shopify/a11y-updates
[Docs] Adds a11y landmarks
2016-04-11 09:31:25 -04:00
Adam Hollett 7e25675dc3 Merge pull request #742 from Shopify/code-labels-for-abs
Add code labels for abs filter
2016-04-11 08:58:22 -04:00
Adam Hollett 89e3728ec8 Add code labels for abs filter 2016-04-11 08:57:20 -04:00
Adam Hollett 424c97464a Merge pull request #738 from Shopify/markdown-renderer
Switch to kramdown/rouge and fix code blocks
2016-04-11 08:53:01 -04:00
Tetsuro c89176b219 Add role attribute for old screen readers 2016-04-10 19:26:03 -04:00
Tetsuro 1d2ad13bd8 Adds a11y landmarks 2016-04-10 19:15:20 -04:00
Adam Hollett d085b5911d Merge pull request #739 from Shopify/abs-filter-docs
Add abs filter docs
2016-04-05 09:43:18 -04:00
Adam Hollett 6c3fc60e32 Add "also" 2016-04-05 09:36:56 -04:00
Adam Hollett 0bfab96fc0 Add abs filter docs 2016-04-05 09:31:44 -04:00
Adam Hollett de82d100d5 Switch to kramdown/rouge and fix code blocks 2016-04-02 18:46:32 -04:00
tetchi e79e4bb615 Merge pull request #723 from Shopify/fed-updates
Make buttons and headers better on mobile
2016-03-20 16:13:45 -04:00
Tetsuro fc87cfaf37 make buttons and headers better on mobile 2016-03-20 16:12:09 -04:00
Justin Li 512bcdd803 Merge pull request #718 from Shopify/docs-misc-fixes
Docs misc fixes
2016-03-19 00:23:05 -04:00
Adam Hollett bda9c570c9 Remove reference to liquidmarkup.org domain 2016-03-18 23:06:29 -04:00
Adam Hollett 76a01254ed Fix some protocols, add alt text 2016-03-18 23:06:12 -04:00
Adam Hollett f4407fe651 Fix truthy example 2016-03-18 22:42:41 -04:00
Adam Hollett 8c6f4c2f92 Fix all the links 2016-03-18 22:42:16 -04:00
Adam Hollett 3b0f5c45c2 Delete unused handles file 2016-03-18 22:42:07 -04:00
Adam Hollett 4b09f0d49c Don't commit Gemfile.lock for GitHub Pages 2016-03-18 22:41:56 -04:00
tetchi dfdaae0409 Merge pull request #717 from Shopify/inertia-scroll
Add inertia scroll
2016-03-18 20:38:46 -04:00
Tetsuro bbf7ef8482 Add inertia scroll 2016-03-18 20:38:16 -04:00
tetchi c9e9bc3529 Merge pull request #716 from Shopify/fix-mobile
[Liquid Docs] Adds mobile layout
2016-03-18 20:32:17 -04:00
Tetsuro 7aa82e8547 Added mobile layout 2016-03-18 20:29:35 -04:00
Justin Li d1a538b5fd Merge pull request #714 from parkr/patch-1
Github ~> GitHub
2016-03-18 19:04:42 -04:00
Parker Moore 75cab2ad13 capital_H_dangit 2016-03-18 16:01:41 -07:00
Florian Weingarten 3a4bc8a153 ¯\_(ツ)_/¯ 2016-03-18 21:59:06 +00:00
Florian Weingarten bc7bc46ffd Revert "Use jekyll-assets"
This reverts commit 9062937951.
2016-03-18 21:54:29 +00:00
Florian Weingarten aa8df89b20 Revert "business"
This reverts commit 2e889c82c8, reversing
changes made to 9062937951.
2016-03-18 21:54:22 +00:00
Adam Hollett 2e889c82c8 business 2016-03-18 17:46:41 -04:00
Adam Hollett 9062937951 Use jekyll-assets 2016-03-18 17:46:09 -04:00
Florian Weingarten 2fe6dcacbc ¯\_(ツ)_/¯ 2016-03-18 21:42:56 +00:00
Adam Hollett 6d5879177d What is even happening 2016-03-18 17:21:26 -04:00
Adam Hollett 9211e2222c Merge pull request #713 from Shopify/docs-update
github-pages and Gemfile
2016-03-18 17:07:41 -04:00
Adam Hollett 977cd55d32 Adds Gemfile and GH pages gem 2016-03-18 17:05:08 -04:00
tetchi e0325c45d2 Merge pull request #712 from Shopify/docs-config-fix
Amend config file
2016-03-18 17:00:12 -04:00
Tetsuro e88c50c70d Amend config file 2016-03-18 16:59:00 -04:00
tetchi 24ffbd0c16 Merge pull request #711 from Shopify/revert-710-revert-513-docs-update
Revert "Revert "Docs Update""
2016-03-18 16:48:51 -04:00
tetchi 90b361a309 Revert "Revert "Docs Update"" 2016-03-18 16:48:27 -04:00
tetchi 26e667a77c Merge pull request #710 from Shopify/revert-513-docs-update
Revert "Docs Update"
2016-03-18 16:19:07 -04:00
tetchi 70ddccd88f Revert "Docs Update" 2016-03-18 16:18:35 -04:00
tetchi 6bc76a92ea Merge pull request #513 from Shopify/docs-update
Docs Update
2016-03-18 16:15:16 -04:00
Adam HollettandTetsuro 74f478679f A few copy-edits 2016-03-15 19:36:29 -04:00
Adam HollettandTetsuro 7b50ceb955 Remove 'codescence' 2016-03-15 19:36:29 -04:00
Adam HollettandTetsuro 7fe3bfcb98 Adds Introduction page
Simplified Introdction page

Spiced up home page more, style changes to code examples
2016-03-15 19:36:27 -04:00
Adam HollettandTetsuro 4aacf3f9a1 Don't bold every sidebar link on the index page
Fixing a bunch of broken links in Tags/Basics
2016-03-15 19:36:24 -04:00
Adam HollettandTetsuro ea16fe9b24 Adds active state to sidebar links 2016-03-15 19:36:24 -04:00
Tetsuro f0883806c4 Style updates + truthy/falsy content udpate 2016-03-15 19:36:24 -04:00
Adam HollettandTetsuro 1aa4d93160 Adds map filter 2016-03-15 19:36:24 -04:00
Tetsuro f5391d0621 Links now have underlines for better visibility 2016-03-15 19:36:23 -04:00
Adam HollettandTetsuro 4d1378b4b3 Uncomplicate the sidebar 2016-03-15 19:36:23 -04:00
Adam Hollett 2790e8c339 Redcarpetify index; edit default filter 2015-12-14 11:08:34 -05:00
Adam Hollett 1579545be2 New content for nearly all filters 2015-12-13 22:39:26 -05:00
Adam Hollett f49b990e94 Simpler code snippets + magic CSS 2015-12-10 20:29:28 -05:00
Adam Hollett 66b98ca025 Don't use a border on inline code tags 2015-12-08 23:37:22 -05:00
Adam Hollett 92f9636ebe Fix front matter 2015-12-04 21:37:27 -05:00
Adam Hollett 74eb3418b6 Tiny fixes 2015-12-04 21:36:13 -05:00
Tetsuro 6ef9c176dd Fixed conflicts 2015-12-04 21:35:11 -05:00
Tetsuro 6bf836b719 Styled input/output codeblocks, going through all docs to make sure codeblocks are consistent 2015-12-04 21:34:18 -05:00
Adam Hollett 1ce90ed355 Refactor config and sidebar 2015-12-04 21:16:07 -05:00
Adam Hollett 90825277d3 Small fixes 2015-12-04 20:52:47 -05:00
Tetsuro 95dc90e503 Begin work on input/output standardization 2015-12-04 20:31:06 -05:00
Adam Hollett def9795c8f Merge remote-tracking branch 'origin/docs-update' into docs-update 2015-12-04 20:05:49 -05:00
Adam Hollett 1e769d9263 Cleanup and config reorg 2015-12-04 20:05:47 -05:00
Tetsuro c51257692d Update Gruntfile to work with Adam's changes 2015-12-04 20:02:56 -05:00
Tetsuro a33a127f81 Fix conflicts 2015-12-04 19:53:59 -05:00
Tetsuro 1504e5ad89 Updating CSS for sidebar 2015-12-04 19:51:46 -05:00
Adam Hollett a55d638690 Why use collections at all? Fixing control flow too 2015-12-04 19:50:03 -05:00
Tetsuro 88e774cb40 CSS adjustments to headers 2015-12-04 19:21:57 -05:00
Adam Hollett 8e3dcf49ba Moving to single collection 2015-12-04 18:56:07 -05:00
Tetsuro f0c7a601c3 Remove h2 classes to make the styles work in other pages 2015-10-16 11:46:03 -04:00
Tetsuro ce1d460d8a Change config file to use pygments, not rouge 2015-10-16 11:19:03 -04:00
Tetsuro fc80f30981 Merge branch 'docs-update' of github.com:Shopify/liquid into docs-update 2015-10-16 11:16:38 -04:00
Tetsuro ffe3ee3754 WIP 2015-10-16 11:16:34 -04:00
Adam Hollett 0147832a64 Polishing up boolean logic and types 2015-10-16 10:53:23 -04:00
Adam Hollett f2a1925033 Updates to types and truthiness 2015-10-15 17:01:53 -04:00
Adam Hollett d63213d463 Minor updates, switch Pigments to Rouge 2015-10-15 17:01:53 -04:00
Tetsuro 68e39b624a Adjusting layout so that every Basics and Tags' content output their own pages 2015-10-15 16:29:00 -04:00
Adam Hollett ea54777dd2 Intro page and small handles update 2015-10-15 13:43:30 -04:00
Tetsuro 34def78926 Added remainder of missing Filters 2015-10-15 13:16:36 -04:00
Tetsuro c744422d0e Added a bunch of missing filters, made some of the copy more consistent 2015-10-15 11:45:13 -04:00
Tetsuro 67b80e35f9 Adding tags, removing custom Liquid 2015-08-28 15:45:28 -04:00
Tetsuro 57ccbd4898 Re-organizing basics content, starting to remove Shopify-specific content 2015-08-28 12:28:11 -04:00
Tetsuro d4c1429ea7 Added missing dependency for Autoprefixer in package.json 2015-08-27 00:21:28 -04:00
Tetsuro ada2a87d8c Started adding Basics section 2015-08-26 19:07:55 -04:00
Tetsuro 6028ddb189 Changing sidebar to deeplinks
Fixed up navigation, collection contents are now output on one page. CSS cleanup
2015-08-26 19:07:51 -04:00
Tetsuro d9b2d50045 WIP: Adding missing filters 2015-07-25 17:48:18 -04:00
Tetsuro 7f550c8bce Left-aligned table headers 2015-07-25 17:09:54 -04:00
Tetsuro a3ceafbcd0 Removed Objects section 2015-07-25 16:50:24 -04:00
Tetsuro d9a08801c5 Added breadcrumb to post titles. Starting to fix alignment for table headers 2015-07-25 15:39:04 -04:00
Tetsuro 0ca571f58c Sidebar work: added collapsing categories
Big refactoring of SCSS

active state for sidebar links

update gitignore for node_modules folder

removing node_modules from index

Sticky Liquid link in sidebar

Cleaned up index page

Adding fixed width to buttons

Refactoring

Converted sidebar to use Collections

Refactor sidebar CSS
2015-07-25 13:49:14 -04:00
Tetsuro 82249c99b3 Set up Grunt
Fixing up Grunt file to watch for directories

Exclude node modules folder from Jekyll built site
2015-07-25 13:48:45 -04:00
tetchi ae3d14bef5 Merge pull request #537 from parkr/docs-update
WIP: Spike out the documentation
2015-03-27 23:01:16 -04:00
Parker Moore ec38c46ff6 Exclude README and CNAME from Jekyll built site. 2015-03-27 13:06:22 -07:00
Parker Moore 13532f7768 Change posts permalink to exclude categories. 2015-03-27 13:05:55 -07:00
Parker Moore 0359e54999 Use Ruby 2.1 in Travis. 2015-03-27 13:04:08 -07:00
Parker Moore b899c61bbc Add an edit link so users can contribute easily. 2015-03-27 13:02:02 -07:00
Garen Torikian 1aeb8a3305 A lot more updates 2015-03-20 16:51:51 -07:00
Garen Torikian 99db066e2a Add docs for the strip commands 2015-03-20 16:23:38 -07:00
Parker Moore 2937f1988b Merge pull request #1 from parkr/updates-to-doc-update
Continue updating documentation
2015-03-18 13:39:05 -07:00
Garen Torikian d65511e328 Add some more docs 2015-03-15 22:10:36 -07:00
Garen Torikian 601e49dc55 pretty tables 2015-03-15 18:23:17 -07:00
Garen Torikian 2232f9157c Add documentation for date 2015-03-15 18:20:32 -07:00
Garen Torikian c09cb6e05a Add scrollbar to the left sidebar 2015-03-15 18:20:25 -07:00
Parker Moore fe0809e2fa Stub out the other filters 2015-03-13 16:39:32 -07:00
Parker Moore f21311b946 Document downcase 2015-03-13 16:32:16 -07:00
Parker Moore adff96b4cf Document divided_by & make liquid raw 2015-03-13 16:29:00 -07:00
Parker Moore 43c2aab84b Add docs for default 2015-03-13 16:20:39 -07:00
Parker Moore dc7cd7704f How do I Liquid? 2015-03-13 16:20:30 -07:00
Parker Moore 57f83933fd Document ceil 2015-03-13 16:11:12 -07:00
Parker Moore 48b5f59b8e Put all the filters on one page 2015-03-13 16:11:04 -07:00
Parker Moore 1b5ff4c86f use a table to show input/output 2015-03-13 16:06:31 -07:00
Parker Moore 963cd58ab6 Add travis build script 2015-03-13 15:40:10 -07:00
Parker Moore f302fce89e Add capitalize docs 2015-03-13 15:39:58 -07:00
Parker Moore 5342f6f55a Add 'append' documentation 2015-03-13 15:29:02 -07:00
Parker Moore 5f1624d6f5 Initial munge of the site. 2015-03-13 15:28:30 -07:00
Tetsuro 447dd346c1 further work on index.md 2015-01-27 16:50:51 -05:00
Tetsuro 26f12734f8 adding readme 2015-01-27 15:30:23 -05:00
Tetsuro 67865368aa Homepage work + Readme 2015-01-27 15:29:13 -05:00
Tetsuro 1fad0e2638 Further work on the homepage 2015-01-27 15:06:23 -05:00
Tetsuro fe4253f872 Realized I don't need flexbox. Position fixed sidebar
Refactoring

Cleaned up some styles
2015-01-27 14:00:57 -05:00
Tetsuro a8dc349f01 starting sidebar coding 2015-01-26 20:41:04 -05:00
Tetsuro 79ec1506de cleaning up stylesheets 2015-01-26 20:32:10 -05:00
Tetsuro e661b5a275 big gutting job 2015-01-26 20:19:33 -05:00
Tetsuro 955a1fae98 Forgot to add files... 2015-01-26 17:53:33 -05:00
Tetsuro ecda8ff57b initial commit, setting up Jekyll 2015-01-26 17:52:23 -05:00
John Duff ba56db81e1 Doesn't look like you can have multiple CNAMEs listed 2011-09-07 12:20:02 -04:00
John Duff 8de5aa2fb4 Add liquidmarkup.com to CNAME as well 2011-09-07 12:08:41 -04:00
John Duff 64b297a180 Move liquidmarkup.org to github pages 2011-09-07 11:44:28 -04:00
Emanuele Vicentini 0239efd826 github generated gh-pages branch 2011-09-07 08:15:23 -07:00
283 changed files with 3703 additions and 20157 deletions
-22
View File
@@ -1,22 +0,0 @@
name: Contributor License Agreement (CLA)
on:
pull_request_target:
types: [opened, synchronize]
issue_comment:
types: [created]
jobs:
cla:
runs-on: ubuntu-latest
if: |
(github.event.issue.pull_request
&& !github.event.issue.pull_request.merged_at
&& contains(github.event.comment.body, 'signed')
)
|| (github.event.pull_request && !github.event.pull_request.merged)
steps:
- uses: Shopify/shopify-cla-action@v1
with:
github-token: ${{ secrets.GITHUB_TOKEN }}
cla-token: ${{ secrets.CLA_TOKEN }}
-36
View File
@@ -1,36 +0,0 @@
name: Liquid
on: [push, pull_request]
env:
BUNDLE_JOBS: 4
BUNDLE_RETRY: 3
jobs:
test:
runs-on: ubuntu-latest
strategy:
matrix:
entry:
- { ruby: 3.0, allowed-failure: false } # minimum supported
- { ruby: 3.2, allowed-failure: false }
- { ruby: 3.3, allowed-failure: false } # latest
- { ruby: ruby-head, allowed-failure: false }
name: Test Ruby ${{ matrix.entry.ruby }}
steps:
- uses: actions/checkout@v3
- uses: ruby/setup-ruby@v1
with:
ruby-version: ${{ matrix.entry.ruby }}
bundler-cache: true
bundler: latest
- run: bundle exec rake
continue-on-error: ${{ matrix.entry.allowed-failure }}
memory_profile:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- uses: ruby/setup-ruby@v1
with:
bundler-cache: true
- run: bundle exec rake memory_profile:run
+41 -8
View File
@@ -1,9 +1,42 @@
*~
*.gem
*.swp
pkg
*.rbc
.rvmrc
.bundle
.byebug_history
_site/
.sass-cache/
node_modules/
Gemfile.lock
# Compiled source #
###################
*.com
*.class
*.dll
*.exe
*.o
*.so
# Packages #
############
# it's better to unpack these files and commit the raw source
# git has its own built in compression methods
*.7z
*.dmg
*.gz
*.iso
*.jar
*.rar
*.tar
*.zip
# Logs and databases #
######################
*.log
*.sql
*.sqlite
# OS generated files #
######################
.DS_Store
.DS_Store?
._*
.Spotlight-V100
.Trashes
ehthumbs.db
Thumbs.db
-28
View File
@@ -1,28 +0,0 @@
inherit_gem:
rubocop-shopify: rubocop.yml
inherit_from:
- .rubocop_todo.yml
require: rubocop-performance
Performance:
Enabled: true
AllCops:
NewCops: disable
SuggestExtensions: false
Exclude:
- 'vendor/bundle/**/*'
Naming/MethodName:
Exclude:
- 'example/server/liquid_servlet.rb'
Style/ClassMethodsDefinitions:
Enabled: false
# liquid filter calls were being mistaken to be calls on arrays
Style/ConcatArrayLiterals:
Exclude:
- 'test/integration/standard_filter_test.rb'
-180
View File
@@ -1,180 +0,0 @@
# This configuration was generated by
# `rubocop --auto-gen-config`
# on 2022-05-18 19:25:47 UTC using RuboCop version 1.29.1.
# The point is for the user to remove these configuration records
# one by one as the offenses are removed from the code base.
# Note that changes in the inspected code, or installation of new
# versions of RuboCop, may require this file to be generated again.
# Offense count: 1
# This cop supports safe auto-correction (--auto-correct).
# Configuration parameters: TreatCommentsAsGroupSeparators, ConsiderPunctuation, Include.
# Include: **/*.gemspec
Gemspec/OrderedDependencies:
Exclude:
- 'liquid.gemspec'
# Offense count: 6
# This cop supports safe auto-correction (--auto-correct).
Layout/ClosingHeredocIndentation:
Exclude:
- 'test/integration/tags/for_tag_test.rb'
# Offense count: 34
# This cop supports safe auto-correction (--auto-correct).
Layout/EmptyLineAfterGuardClause:
Exclude:
- 'lib/liquid/block.rb'
- 'lib/liquid/block_body.rb'
- 'lib/liquid/context.rb'
- 'lib/liquid/drop.rb'
- 'lib/liquid/lexer.rb'
- 'lib/liquid/parser.rb'
- 'lib/liquid/profiler/hooks.rb'
- 'lib/liquid/standardfilters.rb'
- 'lib/liquid/tags/for.rb'
- 'lib/liquid/tags/if.rb'
- 'lib/liquid/utils.rb'
- 'lib/liquid/variable.rb'
- 'lib/liquid/variable_lookup.rb'
- 'performance/shopify/money_filter.rb'
- 'performance/shopify/paginate.rb'
# Offense count: 8
# This cop supports safe auto-correction (--auto-correct).
# Configuration parameters: AllowAliasSyntax, AllowedMethods.
# AllowedMethods: alias_method, public, protected, private
Layout/EmptyLinesAroundAttributeAccessor:
Exclude:
- 'lib/liquid/template.rb'
- 'test/integration/filter_test.rb'
- 'test/integration/tags/include_tag_test.rb'
- 'test/unit/strainer_template_unit_test.rb'
# Offense count: 17
# This cop supports safe auto-correction (--auto-correct).
# Configuration parameters: EnforcedStyle, IndentationWidth.
# SupportedStyles: aligned, indented
Layout/LineEndStringConcatenationIndentation:
Exclude:
- 'test/integration/tags/for_tag_test.rb'
- 'test/integration/tags/increment_tag_test.rb'
# Offense count: 1
# This cop supports safe auto-correction (--auto-correct).
# Configuration parameters: EnforcedStyle, IndentationWidth.
# SupportedStyles: aligned, indented
Layout/MultilineOperationIndentation:
Exclude:
- 'lib/liquid/expression.rb'
# Offense count: 9
Lint/MissingSuper:
Exclude:
- 'lib/liquid/forloop_drop.rb'
- 'lib/liquid/tablerowloop_drop.rb'
- 'test/integration/assign_test.rb'
- 'test/integration/context_test.rb'
- 'test/integration/filter_test.rb'
- 'test/integration/standard_filter_test.rb'
- 'test/integration/tags/for_tag_test.rb'
- 'test/integration/tags/table_row_test.rb'
# Offense count: 44
Naming/ConstantName:
Exclude:
- 'lib/liquid.rb'
- 'lib/liquid/block_body.rb'
- 'lib/liquid/tags/assign.rb'
- 'lib/liquid/tags/capture.rb'
- 'lib/liquid/tags/case.rb'
- 'lib/liquid/tags/cycle.rb'
- 'lib/liquid/tags/for.rb'
- 'lib/liquid/tags/if.rb'
- 'lib/liquid/tags/raw.rb'
- 'lib/liquid/tags/table_row.rb'
- 'lib/liquid/variable.rb'
- 'performance/shopify/comment_form.rb'
- 'performance/shopify/paginate.rb'
- 'test/integration/tags/include_tag_test.rb'
# Offense count: 9
# Configuration parameters: CheckIdentifiers, CheckConstants, CheckVariables, CheckStrings, CheckSymbols, CheckComments, CheckFilepaths, FlaggedTerms.
Naming/InclusiveLanguage:
Exclude:
- 'lib/liquid/drop.rb'
- 'lib/liquid/parse_context.rb'
- 'test/integration/drop_test.rb'
- 'test/integration/tags/if_else_tag_test.rb'
# Offense count: 2
Style/ClassVars:
Exclude:
- 'lib/liquid/condition.rb'
# Offense count: 3
# This cop supports safe auto-correction (--auto-correct).
Style/ExplicitBlockArgument:
Exclude:
- 'test/integration/context_test.rb'
- 'test/integration/tag/disableable_test.rb'
- 'test/integration/tags/for_tag_test.rb'
# Offense count: 2982
# This cop supports safe auto-correction (--auto-correct).
# Configuration parameters: EnforcedStyle, ConsistentQuotesInMultiline.
# SupportedStyles: single_quotes, double_quotes
Style/StringLiterals:
Enabled: false
# Offense count: 20
# This cop supports safe auto-correction (--auto-correct).
# Configuration parameters: EnforcedStyle.
# SupportedStyles: single_quotes, double_quotes
Style/StringLiteralsInInterpolation:
Exclude:
- 'lib/liquid/condition.rb'
- 'lib/liquid/strainer_template.rb'
- 'lib/liquid/tag/disableable.rb'
- 'performance/shopify/shop_filter.rb'
- 'performance/shopify/tag_filter.rb'
# Offense count: 6
# This cop supports safe auto-correction (--auto-correct).
# Configuration parameters: EnforcedStyleForMultiline.
# SupportedStylesForMultiline: comma, consistent_comma, no_comma
Style/TrailingCommaInArrayLiteral:
Exclude:
- 'example/server/example_servlet.rb'
- 'lib/liquid/condition.rb'
- 'test/integration/context_test.rb'
- 'test/integration/standard_filter_test.rb'
- 'test/unit/parse_tree_visitor_test.rb'
# Offense count: 1
# This cop supports safe auto-correction (--auto-correct).
# Configuration parameters: EnforcedStyleForMultiline.
# SupportedStylesForMultiline: comma, consistent_comma, no_comma
Style/TrailingCommaInHashLiteral:
Exclude:
- 'lib/liquid/expression.rb'
# Offense count: 19
# This cop supports safe auto-correction (--auto-correct).
# Configuration parameters: EnforcedStyle, MinSize, WordRegex.
# SupportedStyles: percent, brackets
Style/WordArray:
Exclude:
- 'lib/liquid/tags/if.rb'
- 'liquid.gemspec'
- 'test/integration/assign_test.rb'
- 'test/integration/context_test.rb'
- 'test/integration/drop_test.rb'
- 'test/integration/standard_filter_test.rb'
# Offense count: 117
# This cop supports safe auto-correction (--auto-correct).
# Configuration parameters: AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, AllowedPatterns, IgnoredPatterns.
# URISchemes: http, https
Layout/LineLength:
Max: 260
-1
View File
@@ -1 +0,0 @@
3.3.4
+4
View File
@@ -0,0 +1,4 @@
install: gem install github-pages
script: jekyll build --trace
sudo: false
rvm: 2.1
-28
View File
@@ -1,28 +0,0 @@
# How to contribute
## Things we will merge
* Bugfixes
* Performance improvements
* Features that are likely to be useful to the majority of Liquid users
* Documentation updates that are concise and likely to be useful to the majority of Liquid users
## Things we won't merge
* Code that introduces considerable performance degrations
* Code that touches performance-critical parts of Liquid and comes without benchmarks
* Features that are not important for most people (we want to keep the core Liquid code small and tidy)
* Features that can easily be implemented on top of Liquid (for example as a custom filter or custom filesystem)
* Code that does not include tests
* Code that breaks existing tests
* Documentation changes that are verbose, incorrect or not important to most people (we want to keep it simple and easy to understand)
## Workflow
* [Sign the CLA](https://cla.shopify.com/) if you haven't already
* Fork the Liquid repository
* Create a new branch in your fork
* For updating [Liquid documentation](https://shopify.github.io/liquid/), create it from `gh-pages` branch. (You can skip tests.)
* If it makes sense, add tests for your code and/or run a performance benchmark
* Make sure all tests pass (`bundle exec rake`)
* Create a pull request
+1 -28
View File
@@ -1,30 +1,3 @@
# frozen_string_literal: true
source 'https://rubygems.org'
git_source(:github) do |repo_name|
"https://github.com/#{repo_name}.git"
end
gemspec
gem "base64"
group :benchmark, :test do
gem 'benchmark-ips'
gem 'memory_profiler'
gem 'terminal-table'
install_if -> { RUBY_PLATFORM !~ /mingw|mswin|java/ && RUBY_ENGINE != 'truffleruby' } do
gem 'stackprof'
end
end
group :test do
gem 'rubocop', '~> 1.61.0'
gem 'rubocop-shopify', '~> 2.12.0', require: false
gem 'rubocop-performance', require: false
platform :mri, :truffleruby do
gem 'liquid-c', github: 'Shopify/liquid-c', ref: 'main'
end
end
gem 'github-pages', '>=100', group: :jekyll_plugins
+145
View File
@@ -0,0 +1,145 @@
GEM
remote: https://rubygems.org/
specs:
activesupport (4.2.7)
i18n (~> 0.7)
json (~> 1.7, >= 1.7.7)
minitest (~> 5.1)
thread_safe (~> 0.3, >= 0.3.4)
tzinfo (~> 1.1)
addressable (2.4.0)
coffee-script (2.4.1)
coffee-script-source
execjs
coffee-script-source (1.10.0)
colorator (1.1.0)
ethon (0.9.1)
ffi (>= 1.3.0)
execjs (2.7.0)
faraday (0.9.2)
multipart-post (>= 1.2, < 3)
ffi (1.9.14)
forwardable-extended (2.6.0)
gemoji (2.1.0)
github-pages (104)
activesupport (= 4.2.7)
github-pages-health-check (= 1.2.0)
jekyll (= 3.3.0)
jekyll-avatar (= 0.4.2)
jekyll-coffeescript (= 1.0.1)
jekyll-feed (= 0.8.0)
jekyll-gist (= 1.4.0)
jekyll-github-metadata (= 2.2.0)
jekyll-mentions (= 1.2.0)
jekyll-paginate (= 1.1.0)
jekyll-redirect-from (= 0.11.0)
jekyll-sass-converter (= 1.3.0)
jekyll-seo-tag (= 2.1.0)
jekyll-sitemap (= 0.12.0)
jekyll-swiss (= 0.4.0)
jemoji (= 0.7.0)
kramdown (= 1.11.1)
liquid (= 3.0.6)
listen (= 3.0.6)
mercenary (~> 0.3)
minima (= 2.0.0)
rouge (= 1.11.1)
terminal-table (~> 1.4)
github-pages-health-check (1.2.0)
addressable (~> 2.3)
net-dns (~> 0.8)
octokit (~> 4.0)
public_suffix (~> 1.4)
typhoeus (~> 0.7)
html-pipeline (2.4.2)
activesupport (>= 2)
nokogiri (>= 1.4)
i18n (0.7.0)
jekyll (3.3.0)
addressable (~> 2.4)
colorator (~> 1.0)
jekyll-sass-converter (~> 1.0)
jekyll-watch (~> 1.1)
kramdown (~> 1.3)
liquid (~> 3.0)
mercenary (~> 0.3.3)
pathutil (~> 0.9)
rouge (~> 1.7)
safe_yaml (~> 1.0)
jekyll-avatar (0.4.2)
jekyll (~> 3.0)
jekyll-coffeescript (1.0.1)
coffee-script (~> 2.2)
jekyll-feed (0.8.0)
jekyll (~> 3.3)
jekyll-gist (1.4.0)
octokit (~> 4.2)
jekyll-github-metadata (2.2.0)
jekyll (~> 3.1)
octokit (~> 4.0, != 4.4.0)
jekyll-mentions (1.2.0)
activesupport (~> 4.0)
html-pipeline (~> 2.3)
jekyll (~> 3.0)
jekyll-paginate (1.1.0)
jekyll-redirect-from (0.11.0)
jekyll (>= 2.0)
jekyll-sass-converter (1.3.0)
sass (~> 3.2)
jekyll-seo-tag (2.1.0)
jekyll (~> 3.3)
jekyll-sitemap (0.12.0)
jekyll (~> 3.3)
jekyll-swiss (0.4.0)
jekyll-watch (1.5.0)
listen (~> 3.0, < 3.1)
jemoji (0.7.0)
activesupport (~> 4.0)
gemoji (~> 2.0)
html-pipeline (~> 2.2)
jekyll (>= 3.0)
json (1.8.3)
kramdown (1.11.1)
liquid (3.0.6)
listen (3.0.6)
rb-fsevent (>= 0.9.3)
rb-inotify (>= 0.9.7)
mercenary (0.3.6)
mini_portile2 (2.1.0)
minima (2.0.0)
minitest (5.9.1)
multipart-post (2.0.0)
net-dns (0.8.0)
nokogiri (1.6.8.1)
mini_portile2 (~> 2.1.0)
octokit (4.6.0)
sawyer (~> 0.8.0, >= 0.5.3)
pathutil (0.14.0)
forwardable-extended (~> 2.6)
public_suffix (1.5.3)
rb-fsevent (0.9.8)
rb-inotify (0.9.7)
ffi (>= 0.5.0)
rouge (1.11.1)
safe_yaml (1.0.4)
sass (3.4.22)
sawyer (0.8.0)
addressable (>= 2.3.5, < 2.6)
faraday (~> 0.8, < 0.10)
terminal-table (1.7.3)
unicode-display_width (~> 1.1.1)
thread_safe (0.3.5)
typhoeus (0.8.0)
ethon (>= 0.8.0)
tzinfo (1.2.2)
thread_safe (~> 0.1)
unicode-display_width (1.1.1)
PLATFORMS
ruby
DEPENDENCIES
github-pages (>= 100)
BUNDLED WITH
1.13.1
+72
View File
@@ -0,0 +1,72 @@
// Gruntfile
module.exports = function(grunt) {
require('load-grunt-tasks')(grunt);
// Project configuration.
grunt.initConfig({
pkg: grunt.file.readJSON('package.json'),
watch: {
css: {
files: ['_sass/**/*.scss'],
tasks: ['sass', 'postcss', 'shell:jekyllBuild'],
options: {
atBegin: true
}
},
jekyll: {
files: ['index.md', '_includes/*.html', 'filters/*.*', '_layouts/*.*', 'tags/*.*', 'basics/*.*'],
tasks: ['shell:jekyllBuild']
}
},
sass: {
dist: {
options: {
style: 'expanded',
sourcemap: 'none'
},
files: {
'_site/css/main.css':'_sass/main.scss'
}
}
},
shell: {
jekyllServe: {
command: 'jekyll serve --no-watch'
},
jekyllBuild: {
command: 'jekyll build'
}
},
postcss: {
options: {
map: true,
processors: [
require('autoprefixer-core')({browsers: 'last 2 versions'})
]
},
dist: {
src: '_site/css/*.css'
}
},
concurrent: {
tasks: ['shell:jekyllServe', 'watch'],
options: {
logConcurrentOutput: true
}
}
});
grunt.loadNpmTasks('grunt-contrib-watch');
grunt.loadNpmTasks('grunt-contrib-sass');
grunt.loadNpmTasks('grunt-postcss');
grunt.loadNpmTasks('grunt-concurrent');
grunt.registerTask('default', ['concurrent']);
};
-381
View File
@@ -1,381 +0,0 @@
# Liquid Change Log
## 5.5.0 2024-03-21
Please reference the GitHub release for more information.
## 5.4.0 2022-07-29
### Breaking Changes
* Drop support for end-of-life Ruby versions (2.5 and 2.6) (#1578) [Andy Waite]
### Features
* Allow `#` to be used as an inline comment tag (#1498) [CP Clermont]
### Fixes
* `PartialCache` now shares snippet cache with subcontexts by default (#1553) [Chris AtLee]
* Hash registers no longer leak into subcontexts as static registers (#1564) [Chris AtLee]
* Fix `ParseTreeVisitor` for `with` variable expressions in `Render` tag (#1596) [CP Clermont]
### Changed
* Liquid::Context#registers now always returns a Liquid::Registers object, though supports the most used Hash functions for compatibility (#1553)
## 5.3.0 2022-03-22
### Fixes
* StandardFilter: Fix missing @context on iterations (#1525) [Thierry Joyal]
* Fix warning about block and default value in `static_registers.rb` (#1531) [Peter Zhu]
### Deprecation
* Condition#evaluate to require mandatory context argument in Liquid 6.0.0 (#1527) [Thierry Joyal]
## 5.2.0 2022-03-01
### Features
* Add `remove_last`, and `replace_last` filters (#1422) [Anders Hagbard]
* Eagerly cache global filters (#1524) [Jean Boussier]
### Fixes
* Fix some internal errors in filters from invalid input (#1476) [Dylan Thacker-Smith]
* Allow dash in filter kwarg name for consistency with Liquid::C (#1518) [CP Clermont]
## 5.1.0 / 2021-09-09
### Features
* Add `base64_encode`, `base64_decode`, `base64_url_safe_encode`, and `base64_url_safe_decode` filters (#1450) [Daniel Insley]
* Introduce `to_liquid_value` in `Liquid::Drop` (#1441) [Michael Go]
### Fixes
* Fix support for using a String subclass for the liquid source (#1421) [Dylan Thacker-Smith]
* Add `ParseTreeVisitor` to `RangeLookup` (#1470) [CP Clermont]
* Translate `RangeError` to `Liquid::Error` for `truncatewords` with large int (#1431) [Dylan Thacker-Smith]
## 5.0.1 / 2021-03-24
### Fixes
* Add ParseTreeVisitor to Echo tag (#1414) [CP Clermont]
* Test with ruby 3.0 as the latest ruby version (#1398) [Dylan Thacker-Smith]
* Handle carriage return in newlines_to_br (#1391) [Unending]
### Performance Improvements
* Use split limit in truncatewords (#1361) [Dylan Thacker-Smith]
## 5.0.0 / 2021-01-06
### Features
* Add new `{% render %}` tag (#1122) [Samuel Doiron]
* Add support for `as` in `{% render %}` and `{% include %}` (#1181) [Mike Angell]
* Add `{% liquid %}` and `{% echo %}` tags (#1086) [Justin Li]
* Add [usage tracking](README.md#usage-tracking) [Mike Angell]
* Add `Tag.disable_tags` for disabling tags that prepend `Tag::Disableable` at render time (#1162, #1274, #1275) [Mike Angell]
* Support using a profiler for multiple renders (#1365, #1366) [Dylan Thacker-Smith]
### Fixes
* Fix catastrophic backtracking in `RANGES_REGEX` regular expression (#1357) [Dylan Thacker-Smith]
* Make sure the for tag's limit and offset are integers (#1094) [David Cornu]
* Invokable methods for enumerable reject include (#1151) [Thierry Joyal]
* Allow `default` filter to handle `false` as value (#1144) [Mike Angell]
* Fix render length resource limit so it doesn't multiply nested output (#1285) [Dylan Thacker-Smith]
* Fix duplication of text in raw tags (#1304) [Peter Zhu]
* Fix strict parsing of find variable with a name expression (#1317) [Dylan Thacker-Smith]
* Use monotonic time to measure durations in Liquid::Profiler (#1362) [Dylan Thacker-Smith]
### Breaking Changes
* Require Ruby >= 2.5 (#1131, #1310) [Mike Angell, Dylan Thacker-Smith]
* Remove support for taint checking (#1268) [Dylan Thacker-Smith]
* Split Strainer class into StrainerFactory and StrainerTemplate (#1208) [Thierry Joyal]
* Remove handling of a nil context in the Strainer class (#1218) [Thierry Joyal]
* Handle `BlockBody#blank?` at parse time (#1287) [Dylan Thacker-Smith]
* Pass the tag markup and tokenizer to `Document#unknown_tag` (#1290) [Dylan Thacker-Smith]
* And several internal changes
### Performance Improvements
* Reduce allocations (#1073, #1091, #1115, #1099, #1117, #1141, #1322, #1341) [Richard Monette, Florian Weingarten, Ashwin Maroli]
* Improve resources limits performance (#1093, #1323) [Florian Weingarten, Dylan Thacker-Smith]
## 4.0.3 / 2019-03-12
### Fixed
* Fix break and continue tags inside included templates in loops (#1072) [Justin Li]
## 4.0.2 / 2019-03-08
### Changed
* Add `where` filter (#1026) [Samuel Doiron]
* Add `ParseTreeVisitor` to iterate the Liquid AST (#1025) [Stephen Paul Weber]
* Improve `strip_html` performance (#1032) [printercu]
### Fixed
* Add error checking for invalid combinations of inputs to sort, sort_natural, where, uniq, map, compact filters (#1059) [Garland Zhang]
* Validate the character encoding in url_decode (#1070) [Clayton Smith]
## 4.0.1 / 2018-10-09
### Changed
* Add benchmark group in Gemfile (#855) [Jerry Liu]
* Allow benchmarks to benchmark render by itself (#851) [Jerry Liu]
* Avoid calling `line_number` on String node when rescuing a render error. (#860) [Dylan Thacker-Smith]
* Avoid duck typing to detect whether to call render on a node. [Dylan Thacker-Smith]
* Clarify spelling of `reversed` on `for` block tag (#843) [Mark Crossfield]
* Replace recursion with loop to avoid potential stack overflow from malicious input (#891, #892) [Dylan Thacker-Smith]
* Limit block tag nesting to 100 (#894) [Dylan Thacker-Smith]
* Replace `assert_equal nil` with `assert_nil` (#895) [Dylan Thacker-Smith]
* Remove Spy Gem (#896) [Dylan Thacker-Smith]
* Add `collection_name` and `variable_name` reader to `For` block (#909)
* Symbols render as strings (#920) [Justin Li]
* Remove default value from Hash objects (#932) [Maxime Bedard]
* Remove one level of nesting (#944) [Dylan Thacker-Smith]
* Update Rubocop version (#952) [Justin Li]
* Add `at_least` and `at_most` filters (#954, #958) [Nithin Bekal]
* Add a regression test for a liquid-c trim mode bug (#972) [Dylan Thacker-Smith]
* Use https rather than git protocol to fetch liquid-c [Dylan Thacker-Smith]
* Add tests against Ruby 2.4 (#963) and 2.5 (#981)
* Replace RegExp literals with constants (#988) [Ashwin Maroli]
* Replace unnecessary `#each_with_index` with `#each` (#992) [Ashwin Maroli]
* Improve the unexpected end delimiter message for block tags. (#1003) [Dylan Thacker-Smith]
* Refactor and optimize rendering (#1005) [Christopher Aue]
* Add installation instruction (#1006) [Ben Gift]
* Remove Circle CI (#1010)
* Rename deprecated `BigDecimal.new` to `BigDecimal` (#1024) [Koichi ITO]
* Rename deprecated Rubocop name (#1027) [Justin Li]
### Fixed
* Handle `join` filter on non String joiners (#857) [Richard Monette]
* Fix duplicate inclusion condition logic error of `Liquid::Strainer.add_filter` method (#861)
* Fix `escape`, `url_encode`, `url_decode` not handling non-string values (#898) [Thierry Joyal]
* Fix raise when variable is defined but nil when using `strict_variables` [Pascal Betz]
* Fix `sort` and `sort_natural` to handle arrays with nils (#930) [Eric Chan]
## 4.0.0 / 2016-12-14 / branch "4-0-stable"
### Changed
* Render an opaque internal error by default for non-Liquid::Error (#835) [Dylan Thacker-Smith]
* Ruby 2.0 support dropped (#832) [Dylan Thacker-Smith]
* Add to_number Drop method to allow custom drops to work with number filters (#731)
* Add strict_variables and strict_filters options to detect undefined references (#691)
* Improve loop performance (#681) [Florian Weingarten]
* Rename Drop method `before_method` to `liquid_method_missing` (#661) [Thierry Joyal]
* Add url_decode filter to invert url_encode (#645) [Larry Archer]
* Add global_filter to apply a filter to all output (#610) [Loren Hale]
* Add compact filter (#600) [Carson Reinke]
* Rename deprecated "has_key?" and "has_interrupt?" methods (#593) [Florian Weingarten]
* Include template name with line numbers in render errors (574) [Dylan Thacker-Smith]
* Add sort_natural filter (#554) [Martin Hanzel]
* Add forloop.parentloop as a reference to the parent loop (#520) [Justin Li]
* Block parsing moved to BlockBody class (#458) [Dylan Thacker-Smith]
* Add concat filter to concatenate arrays (#429) [Diogo Beato]
* Ruby 1.9 support dropped (#491) [Justin Li]
* Liquid::Template.file_system's read_template_file method is no longer passed the context. (#441) [James Reid-Smith]
* Remove `liquid_methods` (See https://github.com/Shopify/liquid/pull/568 for replacement)
* Liquid::Template.register_filter raises when the module overrides registered public methods as private or protected (#705) [Gaurav Chande]
### Fixed
* Fix variable names being detected as an operator when starting with contains (#788) [Michael Angell]
* Fix include tag used with strict_variables (#828) [QuickPay]
* Fix map filter when value is a Proc (#672) [Guillaume Malette]
* Fix truncate filter when value is not a string (#672) [Guillaume Malette]
* Fix behaviour of escape filter when input is nil (#665) [Tanel Jakobsoo]
* Fix sort filter behaviour with empty array input (#652) [Marcel Cary]
* Fix test failure under certain timezones (#631) [Dylan Thacker-Smith]
* Fix bug in uniq filter (#595) [Florian Weingarten]
* Fix bug when "blank" and "empty" are used as variable names (#592) [Florian Weingarten]
* Fix condition parse order in strict mode (#569) [Justin Li]
* Fix naming of the "context variable" when dynamically including a template (#559) [Justin Li]
* Gracefully accept empty strings in the date filter (#555) [Loren Hale]
* Fix capturing into variables with a hyphen in the name (#505) [Florian Weingarten]
* Fix case sensitivity regression in date standard filter (#499) [Kelley Reynolds]
* Disallow filters with no variable in strict mode (#475) [Justin Li]
* Disallow variable names in the strict parser that are not valid in the lax parser (#463) [Justin Li]
* Fix BlockBody#warnings taking exponential time to compute (#486) [Justin Li]
## 3.0.5 / 2015-07-23 / branch "3-0-stable"
* Fix test failure under certain timezones [Dylan Thacker-Smith]
## 3.0.4 / 2015-07-17
* Fix chained access to multi-dimensional hashes [Florian Weingarten]
## 3.0.3 / 2015-05-28
* Fix condition parse order in strict mode (#569) [Justin Li]
## 3.0.2 / 2015-04-24
* Expose VariableLookup private members (#551) [Justin Li]
* Documentation fixes
## 3.0.1 / 2015-01-23
* Remove duplicate `index0` key in TableRow tag (#502) [Alfred Xing]
## 3.0.0 / 2014-11-12
* Removed Block#end_tag. Instead, override parse with `super` followed by your code. See #446 [Dylan Thacker-Smith]
* Fixed condition with wrong data types (#423) [Bogdan Gusiev]
* Add url_encode to standard filters (#421) [Derrick Reimer]
* Add uniq to standard filters [Florian Weingarten]
* Add exception_handler feature (#397) and #254 [Bogdan Gusiev, Florian Weingarten]
* Optimize variable parsing to avoid repeated regex evaluation during template rendering #383 [Jason Hiltz-Laforge]
* Optimize checking for block interrupts to reduce object allocation #380 [Jason Hiltz-Laforge]
* Properly set context rethrow_errors on render! #349 [Thierry Joyal]
* Fix broken rendering of variables which are equal to false (#345) [Florian Weingarten]
* Remove ActionView template handler [Dylan Thacker-Smith]
* Freeze lots of string literals for new Ruby 2.1 optimization (#297) [Florian Weingarten]
* Allow newlines in tags and variables (#324) [Dylan Thacker-Smith]
* Tag#parse is called after initialize, which now takes options instead of tokens as the 3rd argument. See #321 [Dylan Thacker-Smith]
* Raise `Liquid::ArgumentError` instead of `::ArgumentError` when filter has wrong number of arguments #309 [Bogdan Gusiev]
* Add a to_s default for liquid drops (#306) [Adam Doeler]
* Add strip, lstrip, and rstrip to standard filters [Florian Weingarten]
* Make if, for & case tags return complete and consistent nodelists (#250) [Nick Jones]
* Prevent arbitrary method invocation on condition objects (#274) [Dylan Thacker-Smith]
* Don't call to_sym when creating conditions for security reasons (#273) [Bouke van der Bijl]
* Fix resource counting bug with respond_to?(:length) (#263) [Florian Weingarten]
* Allow specifying custom patterns for template filenames (#284) [Andrei Gladkyi]
* Allow drops to optimize loading a slice of elements (#282) [Tom Burns]
* Support for passing variables to snippets in subdirs (#271) [Joost Hietbrink]
* Add a class cache to avoid runtime extend calls (#249) [James Tucker]
* Remove some legacy Ruby 1.8 compatibility code (#276) [Florian Weingarten]
* Add default filter to standard filters (#267) [Derrick Reimer]
* Add optional strict parsing and warn parsing (#235) [Tristan Hume]
* Add I18n syntax error translation (#241) [Simon Hørup Eskildsen, Sirupsen]
* Make sort filter work on enumerable drops (#239) [Florian Weingarten]
* Fix clashing method names in enumerable drops (#238) [Florian Weingarten]
* Make map filter work on enumerable drops (#233) [Florian Weingarten]
* Improved whitespace stripping for blank blocks, related to #216 [Florian Weingarten]
## 2.6.3 / 2015-07-23 / branch "2-6-stable"
* Fix test failure under certain timezones [Dylan Thacker-Smith]
## 2.6.2 / 2015-01-23
* Remove duplicate hash key [Parker Moore]
## 2.6.1 / 2014-01-10
Security fix, cherry-picked from master (4e14a65):
* Don't call to_sym when creating conditions for security reasons (#273) [Bouke van der Bijl]
* Prevent arbitrary method invocation on condition objects (#274) [Dylan Thacker-Smith]
## 2.6.0 / 2013-11-25
IMPORTANT: Liquid 2.6 is going to be the last version of Liquid which maintains explicit Ruby 1.8 compatability.
The following releases will only be tested against Ruby 1.9 and Ruby 2.0 and are likely to break on Ruby 1.8.
* Bugfix for #106: fix example servlet [gnowoel]
* Bugfix for #97: strip_html filter supports multi-line tags [Jo Liss]
* Bugfix for #114: strip_html filter supports style tags [James Allardice]
* Bugfix for #117: 'now' support for date filter in Ruby 1.9 [Notre Dame Webgroup]
* Bugfix for #166: truncate filter on UTF-8 strings with Ruby 1.8 [Florian Weingarten]
* Bugfix for #204: 'raw' parsing bug [Florian Weingarten]
* Bugfix for #150: 'for' parsing bug [Peter Schröder]
* Bugfix for #126: Strip CRLF in strip_newline [Peter Schröder]
* Bugfix for #174, "can't convert Fixnum into String" for "replace" [jsw0528]
* Allow a Liquid::Drop to be passed into Template#render [Daniel Huckstep]
* Resource limits [Florian Weingarten]
* Add reverse filter [Jay Strybis]
* Add utf-8 support
* Use array instead of Hash to keep the registered filters [Tasos Stathopoulos]
* Cache tokenized partial templates [Tom Burns]
* Avoid warnings in Ruby 1.9.3 [Marcus Stollsteimer]
* Better documentation for 'include' tag (closes #163) [Peter Schröder]
* Use of BigDecimal on filters to have better precision (closes #155) [Arthur Nogueira Neves]
## 2.5.5 / 2014-01-10 / branch "2-5-stable"
Security fix, cherry-picked from master (4e14a65):
* Don't call to_sym when creating conditions for security reasons (#273) [Bouke van der Bijl]
* Prevent arbitrary method invocation on condition objects (#274) [Dylan Thacker-Smith]
## 2.5.4 / 2013-11-11
* Fix "can't convert Fixnum into String" for "replace" (#173), [jsw0528]
## 2.5.3 / 2013-10-09
* #232, #234, #237: Fix map filter bugs [Florian Weingarten]
## 2.5.2 / 2013-09-03 / deleted
Yanked from rubygems, as it contained too many changes that broke compatibility. Those changes will be on following major releases.
## 2.5.1 / 2013-07-24
* #230: Fix security issue with map filter, Use invoke_drop in map filter [Florian Weingarten]
## 2.5.0 / 2013-03-06
* Prevent Object methods from being called on drops
* Avoid symbol injection from liquid
* Added break and continue statements
* Fix filter parser for args without space separators
* Add support for filter keyword arguments
## 2.4.0 / 2012-08-03
* Performance improvements
* Allow filters in `assign`
* Add `modulo` filter
* Ruby 1.8, 1.9, and Rubinius compatibility fixes
* Add support for `quoted['references']` in `tablerow`
* Add support for Enumerable to `tablerow`
* `strip_html` filter removes html comments
## 2.3.0 / 2011-10-16
* Several speed/memory improvements
* Numerous bug fixes
* Added support for MRI 1.9, Rubinius, and JRuby
* Added support for integer drop parameters
* Added epoch support to `date` filter
* New `raw` tag that suppresses parsing
* Added `else` option to `for` tag
* New `increment` tag
* New `split` filter
## 2.2.1 / 2010-08-23
* Added support for literal tags
## 2.2.0 / 2010-08-22
* Compatible with Ruby 1.8.7, 1.9.1 and 1.9.2-p0
* Merged some changed made by the community
## 1.9.0 / 2008-03-04
* Fixed gem install rake task
* Improve Error encapsulation in liquid by maintaining a own set of exceptions instead of relying on ruby build ins
## Before 1.9.0
* Added If with or / and expressions
* Implemented .to_liquid for all objects which can be passed to liquid like Strings Arrays Hashes Numerics and Booleans. To export new objects to liquid just implement .to_liquid on them and return objects which themselves have .to_liquid methods.
* Added more tags to standard library
* Added include tag ( like partials in rails )
* [...] Gazillion of detail improvements
* Added strainers as filter hosts for better security [Tobias Luetke]
* Fixed that rails integration would call filter with the wrong "self" [Michael Geary]
* Fixed bad error reporting when a filter called a method which doesn't exist. Liquid told you that it couldn't find the filter which was obviously misleading [Tobias Luetke]
* Removed count helper from standard lib. use size [Tobias Luetke]
* Fixed bug with string filter parameters failing to tolerate commas in strings. [Paul Hammond]
* Improved filter parameters. Filter parameters are now context sensitive; Types are resolved according to the rules of the context. Multiple parameters are now separated by the Liquid::ArgumentSeparator: , by default [Paul Hammond]
{{ 'Typo' | link_to: 'http://typo.leetsoft.com', 'Typo - a modern weblog engine' }}
* Added Liquid::Drop. A base class which you can use for exporting proxy objects to liquid which can acquire more data when used in liquid. [Tobias Luetke]
class ProductDrop < Liquid::Drop
def top_sales
Shop.current.products.find(:all, :order => 'sales', :limit => 10 )
end
end
t = Liquid::Template.parse( ' {% for product in product.top_sales %} {{ product.name }} {% endfor %} ' )
t.render('product' => ProductDrop.new )
* Added filter parameters support. Example: {{ date | format_date: "%Y" }} [Paul Hammond]
-20
View File
@@ -1,20 +0,0 @@
Copyright (c) 2005, 2006 Tobias Luetke
Permission is hereby granted, free of charge, to any person obtaining
a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including
without limitation the rights to use, copy, modify, merge, publish,
distribute, sublicense, and/or sell copies of the Software, and to
permit persons to whom the Software is furnished to do so, subject to
the following conditions:
The above copyright notice and this permission notice shall be
included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+6 -153
View File
@@ -1,156 +1,9 @@
[![Build status](https://github.com/Shopify/liquid/actions/workflows/liquid.yml/badge.svg)](https://github.com/Shopify/liquid/actions/workflows/liquid.yml)
[![Inline docs](http://inch-ci.org/github/Shopify/liquid.svg?branch=master)](http://inch-ci.org/github/Shopify/liquid)
# New Liquid Docs
# Liquid template engine
To run, follow these steps:
* [Contributing guidelines](CONTRIBUTING.md)
* [Version history](History.md)
* [Liquid documentation from Shopify](https://shopify.dev/docs/api/liquid)
* [Liquid Wiki at GitHub](https://github.com/Shopify/liquid/wiki)
* [Website](http://liquidmarkup.org/)
1. Download ZIP or clone in GitHub
2. Navigate to `liquid` folder
3. Run `jekyll watch`
4. Open `http://127.0.0.1:4000` in your browser
## Introduction
Liquid is a template engine which was written with very specific requirements:
* It has to have beautiful and simple markup. Template engines which don't produce good looking markup are no fun to use.
* It needs to be non evaling and secure. Liquid templates are made so that users can edit them. You don't want to run code on your server which your users wrote.
* It has to be stateless. Compile and render steps have to be separate so that the expensive parsing and compiling can be done once and later on you can just render it passing in a hash with local variables and objects.
## Why you should use Liquid
* You want to allow your users to edit the appearance of your application but don't want them to run **insecure code on your server**.
* You want to render templates directly from the database.
* You like smarty (PHP) style template engines.
* You need a template engine which does HTML just as well as emails.
* You don't like the markup of your current templating engine.
## What does it look like?
```html
<ul id="products">
{% for product in products %}
<li>
<h2>{{ product.name }}</h2>
Only {{ product.price | price }}
{{ product.description | prettyprint | paragraph }}
</li>
{% endfor %}
</ul>
```
## How to use Liquid
Install Liquid by adding `gem 'liquid'` to your gemfile.
Liquid supports a very simple API based around the Liquid::Template class.
For standard use you can just pass it the content of a file and call render with a parameters hash.
```ruby
@template = Liquid::Template.parse("hi {{name}}") # Parses and compiles the template
@template.render('name' => 'tobi') # => "hi tobi"
```
### Concept of Environments
In Liquid, a "Environment" is a scoped environment that encapsulates custom tags, filters, and other configurations. This allows you to define and isolate different sets of functionality for different contexts, avoiding global overrides that can lead to conflicts and unexpected behavior.
By using environments, you can:
1. **Encapsulate Logic**: Keep the logic for different parts of your application separate.
2. **Avoid Conflicts**: Prevent custom tags and filters from clashing with each other.
3. **Improve Maintainability**: Make it easier to manage and understand the scope of customizations.
4. **Enhance Security**: Limit the availability of certain tags and filters to specific contexts.
We encourage the use of Environments over globally overriding things because it promotes better software design principles such as modularity, encapsulation, and separation of concerns.
Here's an example of how you can define and use Environments in Liquid:
```ruby
user_environment = Liquid::Environment.build do |environment|
environment.register_tag("renderobj", RenderObjTag)
end
Liquid::Template.parse(<<~LIQUID, environment: user_environment)
{% renderobj src: "path/to/model.obj" %}
LIQUID
```
In this example, `RenderObjTag` is a custom tag that is only available within the `user_environment`.
Similarly, you can define another environment for a different context, such as email templates:
```ruby
email_environment = Liquid::Environment.build do |environment|
environment.register_tag("unsubscribe_footer", UnsubscribeFooter)
end
Liquid::Template.parse(<<~LIQUID, environment: email_environment)
{% unsubscribe_footer %}
LIQUID
```
By using Environments, you ensure that custom tags and filters are only available in the contexts where they are needed, making your Liquid templates more robust and easier to manage.
### Error Modes
Setting the error mode of Liquid lets you specify how strictly you want your templates to be interpreted.
Normally the parser is very lax and will accept almost anything without error. Unfortunately this can make
it very hard to debug and can lead to unexpected behaviour.
Liquid also comes with a stricter parser that can be used when editing templates to give better error messages
when templates are invalid. You can enable this new parser like this:
```ruby
Liquid::Environment.default.error_mode = :strict
Liquid::Environment.default.error_mode = :strict # Raises a SyntaxError when invalid syntax is used
Liquid::Environment.default.error_mode = :warn # Adds strict errors to template.errors but continues as normal
Liquid::Environment.default.error_mode = :lax # The default mode, accepts almost anything.
```
If you want to set the error mode only on specific templates you can pass `:error_mode` as an option to `parse`:
```ruby
Liquid::Template.parse(source, error_mode: :strict)
```
This is useful for doing things like enabling strict mode only in the theme editor.
It is recommended that you enable `:strict` or `:warn` mode on new apps to stop invalid templates from being created.
It is also recommended that you use it in the template editors of existing apps to give editors better error messages.
### Undefined variables and filters
By default, the renderer doesn't raise or in any other way notify you if some variables or filters are missing, i.e. not passed to the `render` method.
You can improve this situation by passing `strict_variables: true` and/or `strict_filters: true` options to the `render` method.
When one of these options is set to true, all errors about undefined variables and undefined filters will be stored in `errors` array of a `Liquid::Template` instance.
Here are some examples:
```ruby
template = Liquid::Template.parse("{{x}} {{y}} {{z.a}} {{z.b}}")
template.render({ 'x' => 1, 'z' => { 'a' => 2 } }, { strict_variables: true })
#=> '1 2 ' # when a variable is undefined, it's rendered as nil
template.errors
#=> [#<Liquid::UndefinedVariable: Liquid error: undefined variable y>, #<Liquid::UndefinedVariable: Liquid error: undefined variable b>]
```
```ruby
template = Liquid::Template.parse("{{x | filter1 | upcase}}")
template.render({ 'x' => 'foo' }, { strict_filters: true })
#=> '' # when at least one filter in the filter chain is undefined, a whole expression is rendered as nil
template.errors
#=> [#<Liquid::UndefinedFilter: Liquid error: undefined filter filter1>]
```
If you want to raise on a first exception instead of pushing all of them in `errors`, you can use `render!` method:
```ruby
template = Liquid::Template.parse("{{x}} {{y}}")
template.render!({ 'x' => 1}, { strict_variables: true })
#=> Liquid::UndefinedVariable: Liquid error: undefined variable y
```
### Usage tracking
To help track usages of a feature or code path in production, we have released opt-in usage tracking. To enable this, we provide an empty `Liquid:: Usage.increment` method which you can customize to your needs. The feature is well suited to https://github.com/Shopify/statsd-instrument. However, the choice of implementation is up to you.
Once you have enabled usage tracking, we recommend reporting any events through Github Issues that your system may be logging. It is highly likely this event has been added to consider deprecating or improving code specific to this event, so please raise any concerns.
-120
View File
@@ -1,120 +0,0 @@
# frozen_string_literal: true
require 'rake'
require 'rake/testtask'
$LOAD_PATH.unshift(File.expand_path("../lib", __FILE__))
require "liquid/version"
task(default: [:test, :rubocop])
desc('run test suite with default parser')
Rake::TestTask.new(:base_test) do |t|
t.libs << 'lib' << 'test'
t.test_files = FileList['test/{integration,unit}/**/*_test.rb']
t.verbose = false
end
Rake::TestTask.new(:integration_test) do |t|
t.libs << 'lib' << 'test'
t.test_files = FileList['test/integration/**/*_test.rb']
t.verbose = false
end
desc('run test suite with warn error mode')
task :warn_test do
ENV['LIQUID_PARSER_MODE'] = 'warn'
Rake::Task['base_test'].invoke
end
task :rubocop do
if RUBY_ENGINE == 'ruby'
require 'rubocop/rake_task'
RuboCop::RakeTask.new
end
end
desc('runs test suite with both strict and lax parsers')
task :test do
ENV['LIQUID_PARSER_MODE'] = 'lax'
Rake::Task['base_test'].invoke
ENV['LIQUID_PARSER_MODE'] = 'strict'
Rake::Task['base_test'].reenable
Rake::Task['base_test'].invoke
if RUBY_ENGINE == 'ruby' || RUBY_ENGINE == 'truffleruby'
ENV['LIQUID_C'] = '1'
ENV['LIQUID_PARSER_MODE'] = 'lax'
Rake::Task['integration_test'].reenable
Rake::Task['integration_test'].invoke
ENV['LIQUID_PARSER_MODE'] = 'strict'
Rake::Task['integration_test'].reenable
Rake::Task['integration_test'].invoke
end
end
task(gem: :build)
task :build do
system "gem build liquid.gemspec"
end
task install: :build do
system "gem install liquid-#{Liquid::VERSION}.gem"
end
task release: :build do
system "git tag -a v#{Liquid::VERSION} -m 'Tagging #{Liquid::VERSION}'"
system "git push --tags"
system "gem push liquid-#{Liquid::VERSION}.gem"
system "rm liquid-#{Liquid::VERSION}.gem"
end
namespace :benchmark do
desc "Run the liquid benchmark with lax parsing"
task :run do
ruby "./performance/benchmark.rb lax"
end
desc "Run the liquid benchmark with strict parsing"
task :strict do
ruby "./performance/benchmark.rb strict"
end
desc "Run unit benchmarks"
task :unit do
Dir["./performance/unit/*_benchmark.rb"].each do |file|
puts "🧪 Running #{file}"
ruby file
end
end
end
namespace :profile do
desc "Run the liquid profile/performance coverage"
task :run do
ruby "./performance/profile.rb"
end
desc "Run the liquid profile/performance coverage with strict parsing"
task :strict do
ruby "./performance/profile.rb strict"
end
end
namespace :memory_profile do
desc "Run memory profiler"
task :run do
ruby "./performance/memory_profile.rb"
end
end
desc("Run example")
task :example do
ruby "-w -d -Ilib example/server/server.rb"
end
task :console do
exec 'irb -I lib -r liquid'
end
+34
View File
@@ -0,0 +1,34 @@
title: Liquid template language
description: Liquid is a template language and accompanying rendering engine. It is built for security, so is perfect for rendering custom templates from your users.
# Build settings
baseurl: /liquid # the subpath of your site, e.g. /blog/
url: http://liquidmarkup.org # the base hostname & protocol for your site
permalink: pretty
exclude:
- README.md
- CNAME
- Gemfile
- Gruntfile.js
- package.json
- node_modules
keep_files: ["css"]
# Plugins
gems:
- jekyll-redirect-from
# Front matter defaults
defaults:
- scope:
path: "" # an empty string here means all files in the project
values:
layout: default
- scope:
path: "filters"
values:
type: filter
- scope:
path: "tags"
values:
type: tag
+12
View File
@@ -0,0 +1,12 @@
<div class="home-banner">
<h1>Liquid</h1>
<p>Safe, customer-facing template language for flexible web apps.</p>
<p class="btn-row">
<a href="https://github.com/Shopify/liquid/archive/master.zip" target="_blank" class="btn">
<span aria-hidden="true">{% include icons/desktop-download.svg %}</span> Download
</a>
<a href="https://github.com/Shopify/liquid" target="_blank" class="btn">
<span aria-hidden="true">{% include icons/mark-github.svg %}</span> View on GitHub
</a>
</p>
</div>
+24
View File
@@ -0,0 +1,24 @@
<div class="home-users-grid">
<div class="home-users-grid__item">
<a href="http://jekyllrb.com" target="_blank">
<img src="{{ '/images/jekyll-logo.png' | prepend: site.baseurl }}" alt="Jekyll logo" />
</a>
</div>
<div class="home-users-grid__item">
<a href="http://www.desk.com" target="_blank">
<img src="{{ '/images/salesforcedesk-logo.png' | prepend: site.baseurl }}" alt="Desk logo" />
</a>
</div>
<div class="home-users-grid__item">
<a href="//www.zendesk.com" target="_blank">
<img src="{{ '/images/zendesk-logo.png' | prepend: site.baseurl }}" alt="ZenDesk logo" />
</a>
</div>
<div class="home-users-grid__item">
<a href="//500px.com" target="_blank">
<img src="{{ '/images/500px-logo.png' | prepend: site.baseurl }}" alt="500px logo" />
</a>
</div>
</div>
<p class="home-users-blurb">...and <a href="https://github.com/Shopify/liquid/wiki#who-uses-liquid" target="_blank">many more</a></p>
+1
View File
@@ -0,0 +1 @@
<svg width="16" height="16" viewBox="0 0 16 16" xmlns="http://www.w3.org/2000/svg"><title>desktop-download</title><desc>Created with Sketch.</desc><path d="M4 6h3v-6h2v6h3l-4 4-4-4zm11-4h-4v1h4v8h-14v-8h4v-1h-4c-.55 0-1 .45-1 1v9c0 .55.45 1 1 1h5.34c-.25.61-.86 1.39-2.34 2h8c-1.48-.61-2.09-1.39-2.34-2h5.34c.55 0 1-.45 1-1v-9c0-.55-.45-1-1-1z" fill-rule="evenodd"/></svg>

After

Width:  |  Height:  |  Size: 372 B

+1
View File
@@ -0,0 +1 @@
<svg width="16" height="16" viewBox="0 0 16 16" xmlns="http://www.w3.org/2000/svg"><title>mark-github</title><desc>Created with Sketch.</desc><path d="M8 0c-4.42 0-8 3.58-8 8 0 3.54 2.29 6.53 5.47 7.59.4.07.55-.17.55-.38l-.01-1.49c-2.01.37-2.53-.49-2.69-.94-.09-.23-.48-.94-.82-1.13-.28-.15-.68-.52-.01-.53.63-.01 1.08.58 1.23.82.72 1.21 1.87.87 2.33.66.07-.52.28-.87.51-1.07-1.78-.2-3.64-.89-3.64-3.95 0-.87.31-1.59.82-2.15-.08-.2-.36-1.02.08-2.12 0 0 .67-.21 2.2.82.64-.18 1.32-.27 2-.27.68 0 1.36.09 2 .27 1.53-1.04 2.2-.82 2.2-.82.44 1.1.16 1.92.08 2.12.51.56.82 1.27.82 2.15 0 3.07-1.87 3.75-3.65 3.95.29.25.54.73.54 1.48 0 1.07-.01 1.93-.01 2.2 0 .21.15.46.55.38 3.16-1.06 5.45-4.06 5.45-7.59 0-4.42-3.58-8-8-8z" fill-rule="evenodd"/></svg>

After

Width:  |  Height:  |  Size: 746 B

+1
View File
@@ -0,0 +1 @@
<svg width="12" height="16" viewBox="0 0 12 16" xmlns="http://www.w3.org/2000/svg"><title>three-bars</title><desc>Created with Sketch.</desc><path d="M11.41 9h-10.82c-.59 0-.59-.41-.59-1 0-.59 0-1 .59-1h10.81c.59 0 .59.41.59 1 0 .59 0 1-.59 1h.01zm0-4h-10.82c-.59 0-.59-.41-.59-1 0-.59 0-1 .59-1h10.81c.59 0 .59.41.59 1 0 .59 0 1-.59 1h.01zm-10.82 6h10.81c.59 0 .59.41.59 1 0 .59 0 1-.59 1h-10.81c-.59 0-.59-.41-.59-1 0-.59 0-1 .59-1z" fill="#000"/></svg>

After

Width:  |  Height:  |  Size: 455 B

+18
View File
@@ -0,0 +1,18 @@
<div class="sidebar">
<header class="sidebar__logo" role="banner">
<a href="{{ "/" | prepend: site.baseurl }}">Liquid</a>
</header>
<nav class="sidebar__nav"> {% assign sections = "basics, tags, filters" | split: ", " %}
{% for section in sections %}
<h3 class="section__header">{{ section | capitalize }}</h3>
<ul class="section__links">
{% for item in site.pages %}{% if item.url contains section/ %}{% unless item.path contains "index" %}
<li><a href="{{ item.url | prepend: site.baseurl }}" class="section__link{% if item.url contains page.url and page.url != '/' and page.type != 'index' %} section__link--is-active{% endif %}">{{ item.title }}</a></li>
{% endunless %}{% endif %}{% endfor %}
</ul>
{% endfor %}
</nav>
</div>
+56
View File
@@ -0,0 +1,56 @@
<!DOCTYPE html>
<html>
<head>
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1" />
<title>{% if page.title %}{{ page.title }} {% endif %}{{ site.title }}</title>
<meta name="description" content="{{ page.description | default: site.description }}">
<meta name="author" content="Shopify">
<meta name="robots" content="index, follow">
<meta name="mobile-web-app-capable" content="yes">
<meta name="apple-mobile-web-app-capable" content="yes">
<meta name="apple-mobile-web-app-status-bar-style" content="default">
<link rel="stylesheet" href="{{ '/css/main.css' | prepend: site.baseurl }}">
<link rel="icon" type="image/png" href="{{ '/images/icons/water-drop-32x.png' | prepend: site.baseurl }}" sizes="32x32">
<link rel="icon" type="image/png" href="{{ '/images/icons/water-drop-64x.png' | prepend: site.baseurl }}" sizes="64x64">
<link rel="canonical" href="{{ page.url | replace: 'index.html','' | prepend: site.baseurl | prepend: site.url }}">
<link rel="alternate" type="application/rss+xml" title="{{ site.title }}" href="{{ "/feed.xml" | prepend: site.baseurl | prepend: site.url }}" />
<meta property="og:site_name" content="{{ site.title }}">
<meta property="og:type" content="website">
<meta property="og:url" content="{{ site.url | append: site.baseurl }}">
<meta property="og:title" content="{{ page.title | default: site.title }}">
<meta property="og:description" content="{{ page.description | default: site.description }}">
<meta name="twitter:site" content="{{ site.title }}">
<meta name="twitter:card" content="summary">
<meta name="twitter:url" content="{{ site.url | append: site.baseurl }}">
<meta name="twitter:title" content="{{ page.title | default: site.title }}">
<meta name="twitter:description" content="{{ page.description | default: site.description }}">
<script src="{{ '/js/vendor/jquery-3.1.1.slim.min.js' | prepend: site.baseurl }}"></script>
</head>
<body>
{% include sidebar.html %}
<div class="content__overlay"></div>
<main class="content__area" role="main">
<div class="content">
<button class="menu-button">
<span aria-hidden="true">{% include icons/three-bars.svg %}</span>
<span>Menu</span>
</button>
<h1>{{ page.title }}</h1>
{{ content }}
</div>
</main>
<script src="{{ '/js/script.js' | prepend: site.baseurl }}"></script>
</body>
</html>
+183
View File
@@ -0,0 +1,183 @@
* {
box-sizing: border-box;
}
/**
* Reset some basic elements
*/
body, h1, h2, h3, h4, h5, h6,
p, blockquote, pre, hr,
dl, dd, ol, ul, figure {
margin: 0;
padding: 0;
}
/**
* Basic styling
*/
body {
font-family: $base-font-family;
font-size: $base-font-size;
line-height: $base-line-height;
font-weight: 300;
color: $color-slate;
-webkit-text-size-adjust: 100%;
}
/** Set `margin-bottom` to maintain vertical rhythm */
h1, h2, h3, h4, h5, h6,
p, blockquote, pre,
ul, ol, dl, figure,
%vertical-rhythm {
margin-bottom: $spacing-unit / 2;
}
/** Images */
img {
max-width: 100%;
vertical-align: middle;
}
/** Figures */
figure > img {
display: block;
}
figcaption {
font-size: $small-font-size;
}
/** Lists */
ul, ol {
margin-left: $spacing-unit;
}
li {
> ul, > ol {
margin-bottom: 0;
}
}
/** Links */
a {
color: $color-blue-5;
&:visited {
color: #609;
}
&:hover {
text-decoration: underline;
}
}
/** Headings */
h1 {
font-size: 2em;
font-weight: 300;
}
h2 {
font-size: 1.5em;
font-weight: 300;
margin-top: $spacing-unit;
}
h3 {
margin-top: $spacing-unit;
font-size: 1em;
}
h4 {
font-size: 1em;
}
blockquote {
color: lighten($color-slate, 30%);
border-left: 2px solid lighten($color-slate, 50%);
padding-left: $spacing-unit / 2;
letter-spacing: -1px;
font-style: italic;
> :last-child {
margin-bottom: 0;
}
}
pre, code {
font-family: Menlo, Monaco, monospace;
font-size: 15px;
border-radius: 3px;
background-color: lighten($color-blue-1, 0.9);
}
code {
padding: 1px 5px;
}
pre {
padding: 8px 12px;
border: 1px solid $color-blue-2;
word-wrap: break-word;
> code {
border: 0;
padding-right: 0;
padding-left: 0;
}
}
hr {
display: block;
height: 1px;
border: 0;
background-color: lighten($color-slate, 50%);
margin-bottom: $spacing-unit/2;
}
table {
width: 100%;
overflow: auto;
display: block;
margin: 15px 0;
border-collapse: collapse;
thead {
margin: 0;
padding: 0;
border: 0;
font-size: 100%;
font: inherit;
vertical-align: baseline;
}
th {
border: 1px solid #ddd;
padding: 6px 13px;
font-weight: bold;
text-align: center;
}
tbody {
vertical-align: middle;
border-color: inherit;
}
tr {
border-top: 1px solid #ccc;
background-color: #fff;
vertical-align: inherit;
}
td {
border: 1px solid #ddd;
padding: 6px 13px;
}
/* Don't use a margin on code samples within tables */
pre {
margin-bottom: 0;
}
}
p {
line-height: 1.8;
}
+84
View File
@@ -0,0 +1,84 @@
.btn {
color: $color-white;
fill: currentColor;
display: flex;
background: $color-blue-5;
align-items: center;
justify-content: center;
padding: $spacing-unit/4 $spacing-unit/2;
border-radius: 8px;
text-decoration: none;
text-align: center;
white-space: nowrap;
&:hover {
background: $color-blue-4;
cursor: pointer;
text-decoration: none;
}
&:first-child {
margin-bottom: $spacing-unit / 2;
}
@include phone-and-up {
justify-content: center;
&:first-child {
justify-content: flex-start;
margin-bottom: 0;
}
}
svg {
margin-right: $spacing-unit / 4;
width: $base-font-size * 1.5;
height: $base-font-size * 1.5;
vertical-align: middle;
}
}
.btn:visited {
color: $color-white;
}
.btn-row {
display: flex;
justify-content: center;
flex-direction: column;
margin-bottom: 0;
@include phone-and-up {
flex-direction: row;
.btn:not(:first-child) {
margin-left: $spacing-unit / 2;
}
}
}
/*============================================================================
Menu button
==============================================================================*/
.menu-button {
display: inline-block;
font-size: $small-font-size;
background: none;
border: none;
margin: $spacing-unit / 2 0 $spacing-unit / 2 ($spacing-unit / 4 * -1);
padding: $spacing-unit / 4;
color: $color-slate;
@include tablet-and-up {
display: none;
}
svg {
margin-right: $spacing-unit / 4;
width: $base-font-size;
height: $base-font-size;
vertical-align: middle;
}
}
+22
View File
@@ -0,0 +1,22 @@
.content__item {
margin-bottom: $spacing-unit * 2;
}
.highlight {
background: lighten($color-blue-1, 1);
}
.code-label {
padding: 4px 12px;
margin-bottom: 0;
font-size: 15px;
background: darken($color-blue-1, 5);
border: 1px solid $color-blue-2;
border-bottom: none;
border-radius: 3px 3px 0 0;
}
.code-label + .highlighter-rouge .highlight {
border-top: none;
border-radius: 0 0 3px 3px;
}
+23
View File
@@ -0,0 +1,23 @@
.home-banner {
text-align: center;
border-bottom: 1px solid lighten($color-slate, 50%);
padding-bottom: $spacing-unit;
margin-bottom: $spacing-unit;
h1 {
font-size: 4em;
// &:after {
// content: '\01F4A7'; // Water droplet emoji
// vertical-align: middle;
// }
@include phone-and-up {
font-size: 5em;
}
}
p {
color: lighten($color-slate, 20%);
}
}
+20
View File
@@ -0,0 +1,20 @@
.home-users-grid {
display: flex;
align-items: center;
flex-wrap: wrap;
margin-bottom: $spacing-unit / 2;
}
.home-users-grid__item{
flex: 1;
margin-right: $spacing-unit / 2;
max-width: 50%;
&:last-child {
margin-right: 0;
}
}
.home-users-blurb {
text-align: right;
}
+155
View File
@@ -0,0 +1,155 @@
$sidebar-width: 250px;
$logo-height: 130px;
$wrapper-width: 800px;
body {
// display: flex;
// flex-direction: column;
// @include tablet-and-up {
// flex-direction: row;
// }
}
/*============================================================================
Content Area
==============================================================================*/
.content__area {
width: 100%;
@include tablet-and-up {
padding: $spacing-unit $spacing-unit $spacing-unit ($spacing-unit + $sidebar-width);
}
}
.content__overlay {
background: rgba(0, 0, 0, 0.4);
width: 100%;
height: 100vh;
position: fixed;
z-index: 1;
display: none;
}
.content__overlay--is-active {
display: block;
}
.content {
max-width: $wrapper-width;
margin: 0 auto;
padding: 0 $spacing-unit;
@extend %clearfix;
}
/*============================================================================
Sidebar
==============================================================================*/
.sidebar {
background: $color-blue-5;
width: $sidebar-width;
position: fixed;
transform: translateX($sidebar-width * -1);
transition: all 0.15s ease;
z-index: 2;
height: 100vh;
-webkit-overflow-scrolling: touch;
@include tablet-and-up {
transform: translateX(0);
}
}
.sidebar--is-visible {
transform: translateX(0);
}
.sidebar__logo {
font-size: $base-font-size * 2;
font-weight: 300;
text-align: center;
height: $logo-height;
line-height: $logo-height;
margin-bottom: 0;
border-bottom: 1px solid $color-blue-4;
// &:after {
// content: '\01F4A7'; // Water droplet emoji
// vertical-align: middle;
// }
a {
color: $color-white;
text-decoration: none;
&:hover {
text-decoration: underline;
}
}
}
.sidebar__nav {
padding: $spacing-unit $spacing-unit ($spacing-unit + $logo-height); // Add a bit more padding at the bottom for consistency.
font-weight: bold;
max-height: 100%;
overflow-y: scroll;
li {
list-style: none;
a {
color: $color-white;
&:hover {
text-decoration: none;
}
}
}
}
.section {
margin: 0px;
> li {
margin-bottom: $spacing-unit / 2;
&:last-child {
margin-bottom: $spacing-unit;
}
}
}
.section__header {
font-size: 1em;
text-decoration: none;
color: $color-white;
margin-top: 0;
margin-bottom: $spacing-unit / 4;
}
.section__links {
margin-left: $spacing-unit / 2;
margin-bottom: $spacing-unit;
font-weight: normal;
font-size: 0.9em;
}
.section__link {
display: inline-block;
margin-top: $spacing-unit/4;
opacity: 0.75;
text-decoration: none;
&:hover {
opacity: 1;
}
}
.section__link--is-active {
font-weight: bold;
opacity: 1;
}
+10
View File
@@ -0,0 +1,10 @@
// I got the blues, man.
// 1 --> 5, lightest --> darkest.
$color-blue-1: #E8F8FF;
$color-blue-2: #B4DCED;
$color-blue-3: #91C9E8;
$color-blue-4: #67B8DE;
$color-blue-5: #3399CC;
$color-white: #ffffff;
$color-slate: #5E5E5E;
+5
View File
@@ -0,0 +1,5 @@
$base-font-family: -apple-system, BlinkMacSystemFont, San Francisco, Segoe UI, Roboto, Helvetica Neue, sans-serif;
$base-font-size: 18px;
$small-font-size: $base-font-size * 0.875;
$base-line-height: 1.5;
$spacing-unit: 40px;
+16
View File
@@ -0,0 +1,16 @@
%clearfix {
&:after {
content: "";
display: table;
clear: both;
}
}
.visually-hidden {
position:absolute;
left:-10000px;
top:auto;
width:1px;
height:1px;
overflow:hidden;
}
+43
View File
@@ -0,0 +1,43 @@
/*============================================================================
Media queries
==============================================================================*/
$phone-width: 375px;
$tablet-width: 768px;
$desktop-width: 1024px;
@mixin phone {
@media (max-width: #{$phone-width}) {
@content;
}
}
@mixin phone-and-up {
@media (min-width: #{$phone-width}) {
@content;
}
}
@mixin phone-to-tablet {
@media (min-width: #{$phone-width}) and (max-width: #{$tablet-width - 1px}) {
@content;
}
}
@mixin tablet {
@media (min-width: #{$tablet-width}) and (max-width: #{$desktop-width - 1px}) {
@content;
}
}
@mixin tablet-and-up {
@media (min-width: #{$tablet-width}) {
@content;
}
}
@mixin desktop {
@media (min-width: #{$desktop-width}) {
@content;
}
}
+67
View File
@@ -0,0 +1,67 @@
/**
* Syntax highlighting styles
*/
.highlight {
// background: #fff;
@extend %vertical-rhythm;
.c { color: #998; font-style: italic } // Comment
.err { color: #a61717; background-color: #e3d2d2 } // Error
.k { font-weight: bold } // Keyword
.o { font-weight: bold } // Operator
.cm { color: #998; font-style: italic } // Comment.Multiline
.cp { color: #999; font-weight: bold } // Comment.Preproc
.c1 { color: #998; font-style: italic } // Comment.Single
.cs { color: #999; font-weight: bold; font-style: italic } // Comment.Special
.gd { color: #000; background-color: #fdd } // Generic.Deleted
.gd .x { color: #000; background-color: #faa } // Generic.Deleted.Specific
.ge { font-style: italic } // Generic.Emph
.gr { color: #a00 } // Generic.Error
.gh { color: #999 } // Generic.Heading
.gi { color: #000; background-color: #dfd } // Generic.Inserted
.gi .x { color: #000; background-color: #afa } // Generic.Inserted.Specific
.go { color: #888 } // Generic.Output
.gp { color: #555 } // Generic.Prompt
.gs { font-weight: bold } // Generic.Strong
.gu { color: #aaa } // Generic.Subheading
.gt { color: #a00 } // Generic.Traceback
.kc { font-weight: bold } // Keyword.Constant
.kd { font-weight: bold } // Keyword.Declaration
.kp { font-weight: bold } // Keyword.Pseudo
.kr { font-weight: bold } // Keyword.Reserved
.kt { color: #458; font-weight: bold } // Keyword.Type
.m { color: #099 } // Literal.Number
.s { color: #d14 } // Literal.String
.na { color: #008080 } // Name.Attribute
.nb { color: #0086B3 } // Name.Builtin
.nc { color: #458; font-weight: bold } // Name.Class
.no { color: #008080 } // Name.Constant
.ni { color: #800080 } // Name.Entity
.ne { color: #900; font-weight: bold } // Name.Exception
.nf { color: #900; font-weight: bold } // Name.Function
.nn { color: #555 } // Name.Namespace
.nt { color: #000080 } // Name.Tag
.nv { color: #008080 } // Name.Variable
.ow { font-weight: bold } // Operator.Word
.w { color: #bbb } // Text.Whitespace
.mf { color: #099 } // Literal.Number.Float
.mh { color: #099 } // Literal.Number.Hex
.mi { color: #099 } // Literal.Number.Integer
.mo { color: #099 } // Literal.Number.Oct
.sb { color: #d14 } // Literal.String.Backtick
.sc { color: #d14 } // Literal.String.Char
.sd { color: #d14 } // Literal.String.Doc
.s2 { color: #d14 } // Literal.String.Double
.se { color: #d14 } // Literal.String.Escape
.sh { color: #d14 } // Literal.String.Heredoc
.si { color: #d14 } // Literal.String.Interpol
.sx { color: #d14 } // Literal.String.Other
.sr { color: #009926 } // Literal.String.Regex
.s1 { color: #d14 } // Literal.String.Single
.ss { color: #990073 } // Literal.String.Symbol
.bp { color: #999 } // Name.Builtin.Pseudo
.vc { color: #008080 } // Name.Variable.Class
.vg { color: #008080 } // Name.Variable.Global
.vi { color: #008080 } // Name.Variable.Instance
.il { color: #099 } // Literal.Number.Integer.Long
}
+3
View File
@@ -0,0 +1,3 @@
---
redirect_to: /liquid/basics/introduction
---
+70
View File
@@ -0,0 +1,70 @@
---
title: Introduction
description: An overview of objects, tags, and filters in the Liquid template language.
---
Liquid code can be categorized into [**objects**](#objects), [**tags**](#tags), and [**filters**](#filters).
## 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 %}`.
<p class="code-label">Input</p>
```liquid
{% raw %}
{{ page.title }}
{% endraw %}
```
<p class="code-label">Output</p>
```text
Introduction
```
In this case, Liquid is rendering the content of an object called `page.title`, and that object contains the text `Introduction`.
## 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.
<p class="code-label">Input</p>
```liquid
{% raw %}
{% if user %}
Hello {{ user.name }}!
{% endif %}
{% endraw %}
```
<p class="code-label">Output</p>
```text
Hello Adam!
```
Tags can be categorized into three types:
- [Control flow]({{ "/tags/control-flow" | prepend: site.baseurl }})
- [Iteration]({{ "/tags/iteration" | prepend: site.baseurl }})
- [Variable assignments]({{ "/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 `|`.
<p class="code-label">Input</p>
```liquid
{% raw %}
{{ "/my/fancy/url" | append: ".html" }}
{% endraw %}
```
<p class="code-label">Output</p>
```text
{{ "/my/fancy/url" | append: ".html" }}
```
+89
View File
@@ -0,0 +1,89 @@
---
title: Operators
description: Using operators to perform calculations in the Liquid template language.
---
Liquid includes many logical and comparison operators.
## Basic operators
<table>
<tbody>
<tr>
<td><code>==</code></td>
<td>equals</td>
</tr>
<tr>
<td><code>!=</code></td>
<td>does not equal</td>
</tr>
<tr>
<td><code>&gt;</code></td>
<td>greater than</td>
</tr>
<tr>
<td><code>&lt;</code></td>
<td>less than</td>
</tr>
<tr>
<td><code>&gt;=</code></td>
<td>greater than or equal to</td>
</tr>
<tr>
<td><code>&lt;=</code></td>
<td>less than or equal to</td>
</tr>
<tr>
<td><code>or</code></td>
<td>logical or</td>
</tr>
<tr>
<td><code>and</code></td>
<td>logical and</td>
</tr>
</tbody>
</table>
For example:
```liquid
{% raw %}
{% if product.title == "Awesome Shoes" %}
These shoes are awesome!
{% endif %}
{% endraw %}
```
You can use multiple operators in a tag:
```liquid
{% raw %}
{% if product.type == "Shirt" or product.type == "Shoes" %}
This is a shirt or a pair of shoes.
{% endif %}
{% endraw %}
```
## contains
`contains` checks for the presence of a substring inside a string.
```liquid
{% raw %}
{% if product.title contains 'Pack' %}
This product's title contains the word Pack.
{% endif %}
{% endraw %}
```
`contains` can also check for the presence of a string in an array of strings.
```liquid
{% raw %}
{% if product.tags contains 'Hello' %}
This product has been tagged with 'Hello'.
{% endif %}
{% endraw %}
```
`contains` can only search strings. You cannot use it to check for an object in an array of objects.
+65
View File
@@ -0,0 +1,65 @@
---
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)
## 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:
```liquid
{% raw %}
{% assign tobi = "Tobi" %}
{% if tobi %}
This condition will always be true.
{% 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:
<p class="code-label">Input</p>
```liquid
{% raw %}
{% if settings.fp_heading %}
<h1>{{ settings.fp_heading }}</h1>
{% endif %}
{% endraw %}
```
<p class="code-label">Output</p>
```html
<h1></h1>
```
## Falsy
The falsy values in Liquid are [`nil`]({{ "/basics/types/#nil" | prepend: site.baseurl }}) and [`false`]({{ "/basics/types/#boolean" | prepend: site.baseurl }}).
## Summary
The table below summarizes what is truthy or falsy in Liquid.
| | truthy | falsy |
| ------------- |:-------------:|:-------------:|
| true | • | |
| false | | • |
| nil | | • |
| string | • | |
| empty string | • | |
| 0 | • | |
| integer | • | |
| float | • | |
| array | • | |
| empty array | • | |
| page | • | |
| EmptyDrop | • | |
+128
View File
@@ -0,0 +1,128 @@
---
title: Types
description: An overview of data types in the Liquid template language.
---
Liquid objects can have one of six types:
- [String](#string)
- [Number](#number)
- [Boolean](#boolean)
- [Nil](#nil)
- [Array](#array)
You can initialize Liquid variables with the [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:
```liquid
{% raw %}
{% assign my_string = "Hello World!" %}
{% endraw %}
```
## Number
Numbers include floats and integers:
```liquid
{% raw %}
{% assign my_int = 25 %}
{% assign my_float = 39.756 %}
{% endraw %}
```
## Boolean
Booleans are either `true` or `false`. No quotations are necessary when declaring a boolean:
```liquid
{% raw %}
{% assign foo = true %}
{% assign bar = false %}
{% endraw %}
```
## Nil
Nil is a special empty value that is returned when Liquid code has no results. It is **not** a string with the characters "nil".
Nil is [treated as false]({{ "/basics/truthy-and-falsy" | prepend: site.baseurl }}) in the conditions of `if` blocks and other Liquid tags that check the truthfulness of a statement.
In the following example, if the user does not exist (that is, `user` returns `nil`), Liquid will not print the greeting:
```liquid
{% raw %}
{% if user %}
Hello {{ user.name }}!
{% endif %}
{% endraw %}
```
Tags or outputs that return `nil` will not print anything to the page.
<p class="code-label">Input</p>
```liquid
{% raw %}
The current user is {{ user.name }}
{% endraw %}
```
<p class="code-label">Output</p>
```text
The current user is
```
## Array
Arrays hold lists of variables of any type.
### Accessing items in arrays
To access all the items in an array, you can loop through each item in the array using an [iteration tag]({{ "/tags/iteration" | prepend: site.baseurl }}).
<p class="code-label">Input</p>
```liquid
{% raw %}
<!-- if site.users = "Tobi", "Laura", "Tetsuro", "Adam" -->
{% for user in site.users %}
{{ user }}
{% endfor %}
{% endraw %}
```
<p class="code-label">Output</p>
```text
{% raw %}
Tobi Laura Tetsuro Adam
{% endraw %}
```
### Accessing specific items in arrays
You can use square bracket `[` `]` notation to access a specific item in an array. Array indexing starts at zero.
<p class="code-label">Input</p>
```liquid
{% raw %}
<!-- if site.users = "Tobi", "Laura", "Tetsuro", "Adam" -->
{{ site.users[0] }}
{{ site.users[1] }}
{{ site.users[3] }}
{% endraw %}
```
<p class="code-label">Output</p>
```text
Tobi
Laura
Adam
```
### Initializing arrays
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.
+24
View File
@@ -0,0 +1,24 @@
---
title: Variations of Liquid
description: An overview of the different installations of Liquid and how Liquid can change depending on where you're using it.
---
Liquid is a flexible, safe language, and is used in many different environments. Liquid was created for use in [Shopify](https://www.shopify.com) stores, and is also used extensively on [Jekyll](https://jekyllrb.com) websites. Over time, both Shopify and Jekyll have added their own objects, tags, and filters to Liquid. The most popular versions of Liquid that exist are **Liquid**, **Shopify Liquid**, and **Jekyll Liquid**.
This site documents the latest version of **Liquid** including betas and release candidates — that is, Liquid as it exists outside of Shopify and Jekyll. If you download the Liquid repository or install it as a [gem](https://rubygems.org/gems/liquid), you will get access to whatever objects, tags, and filters are in the version of Liquid that you chose.
## Shopify
Shopify always uses the latest version of Liquid as a base, but Shopify adds a significant number of objects, tags, and filters to Liquid for use in merchants' stores. These include objects representing store, product, and customer information, and filters for displaying store data and manipulating storefront assets like product images.
Shopify's version of Liquid is documented in the [Shopify Help Center](https://help.shopify.com/themes/liquid). If you want to try out Shopify's version of Liquid, you can [start a free trial of Shopify](https://www.shopify.com/signup) or use a sandbox like [DropPen](http://droppen.org/).
## Jekyll
[Jekyll](https://jekyllrb.com) is a static site generator, a command-line tool that creates websites by merging templates with content files. Jekyll uses Liquid as its template language, and adds a few objects, tags, and filters. These include objects representing content pages, tags for including snippets of content in others, and filters for manipulating strings and URLs.
Jekyll also powers [GitHub Pages](https://pages.github.com/), a web hosting service that lets you push a Jekyll installation to a GitHub repository and have the resulting website published. This website is built using GitHub Pages.
Jekyll might not be using the latest version of Liquid. This means that the tags and filters listed on this site may not work in Jekyll. Often the Jekyll project will wait for a stable release of Liquid rather than using a beta or release candidate version. To see what version of Liquid Jekyll is using, check the **runtime dependencies** section of [Jekyll's gem page](https://rubygems.org/gems/jekyll).
Jekyll's version of Liquid is documented in the [Templates section of Jekyll's documentation](http://jekyllrb.com/docs/templates/). If you want to try out Jekyll's version of Liquid, you can clone the Jekyll project or install Jekyll as a gem and test Liquid on a static site.
+80
View File
@@ -0,0 +1,80 @@
---
title: Whitespace control
description: An overview of controlling whitespace between code in the Liquid template language.
---
In Liquid, you can include a hyphen in your tag syntax `{% raw %}{{-{% endraw %}`, `{% raw %}-}}{% endraw %}`, `{% raw %}{%-{% endraw %}`, and `{% raw %}-%}{% endraw %}` to strip whitespace from the left or right side of a rendered tag.
Normally, even if it doesn't output text, any line of Liquid in your template will still output a blank line in your rendered HTML:
<p class="code-label">Input</p>
{% raw %}
``` liquid
{% assign my_variable = "tomato" %}
{{ my_variable }}
```
{% endraw %}
Notice the blank line before "tomato" in the rendered template:
<p class="code-label">Output</p>
``` text
{% assign my_variable = "tomato" %}
{{ my_variable }}
```
By including hyphens in your `assign` tag, you can strip the generated whitespace from the rendered template:
<p class="code-label">Input</p>
{% raw %}
``` liquid
{%- assign my_variable = "tomato" -%}
{{ my_variable }}
```
{% endraw %}
<p class="code-label">Output</p>
``` text
tomato
```
If you don't want any of your tags to output whitespace, as a general rule you can add hyphens to both sides of all your tags (`{% raw %}{%-{% endraw %}` and `{% raw %}-%}{% endraw %}`):
<p class="code-label">Input</p>
{% raw %}
``` liquid
{% assign username = "John G. Chalmers-Smith" %}
{% if username and username.size > 10 %}
Wow, {{ username }}, you have a long name!
{% else %}
Hello there!
{% endif %}
```
{% endraw %}
<p class="code-label">Output without whitespace control</p>
``` text
{% assign username = "John G. Chalmers-Smith" %}
{% if username and username.size > 10 %}
Wow, {{ username }}, you have a long name!
{% else %}
Hello there!
{% endif %}
```
<p class="code-label">Input</p>
{% raw %}
``` liquid
{%- assign username = "John G. Chalmers-Smith" -%}
{%- if username and username.size > 10 -%}
Wow, {{ username }}, you have a long name!
{%- else -%}
Hello there!
{%- endif -%}
```
{% endraw %}
<p class="code-label">Output with whitespace control</p>
``` text
Wow, John G. Chalmers-Smith, you have a long name!
```
Executable
+19
View File
@@ -0,0 +1,19 @@
---
layout: null
---
@charset "utf-8";
@import "partials/defaults";
@import "partials/colors";
@import "partials/helpers";
@import "partials/media-queries";
@import "modules/base";
@import "modules/layout";
@import "modules/buttons";
@import "modules/home-banner";
@import "modules/home-users-grid";
@import "modules/content-area";
@import "vendors/syntax-highlighting";
-50
View File
@@ -1,50 +0,0 @@
# frozen_string_literal: true
module ProductsFilter
def price(integer)
format("$%.2d USD", integer / 100.0)
end
def prettyprint(text)
text.gsub(/\*(.*)\*/, '<b>\1</b>')
end
def count(array)
array.size
end
def paragraph(p)
"<p>#{p}</p>"
end
end
class Servlet < LiquidServlet
def index
{ 'date' => Time.now }
end
def products
{ 'products' => products_list, 'more_products' => more_products_list, 'description' => description, 'section' => 'Snowboards', 'cool_products' => true }
end
private
def products_list
[
{ 'name' => 'Arbor Draft', 'price' => 39900, 'description' => 'the *arbor draft* is a excellent product' },
{ 'name' => 'Arbor Element', 'price' => 40000, 'description' => 'the *arbor element* rocks for freestyling' },
{ 'name' => 'Arbor Diamond', 'price' => 59900, 'description' => 'the *arbor diamond* is a made up product because im obsessed with arbor and have no creativity' }
]
end
def more_products_list
[
{ 'name' => 'Arbor Catalyst', 'price' => 39900, 'description' => 'the *arbor catalyst* is an advanced drop-through for freestyle and flatground performance and versatility' },
{ 'name' => 'Arbor Fish', 'price' => 40000, 'description' => 'the *arbor fish* is a compact pin that features an extended wheelbase and time-honored teardrop shape' }
]
end
def description
"List of Products ~ This is a list of products with price and description."
end
end
-30
View File
@@ -1,30 +0,0 @@
# frozen_string_literal: true
class LiquidServlet < WEBrick::HTTPServlet::AbstractServlet
def do_GET(req, res)
handle(:get, req, res)
end
def do_POST(req, res)
handle(:post, req, res)
end
private
def handle(_type, req, res)
@request = req
@response = res
@request.path_info =~ /(\w+)\z/
@action = Regexp.last_match(1) || 'index'
@assigns = send(@action) if respond_to?(@action)
@response['Content-Type'] = "text/html"
@response.status = 200
@response.body = Liquid::Template.parse(read_template).render(@assigns, filters: [ProductsFilter])
end
def read_template(filename = @action)
File.read("#{__dir__}/templates/#{filename}.liquid")
end
end
-14
View File
@@ -1,14 +0,0 @@
# frozen_string_literal: true
require 'webrick'
require 'rexml/document'
require_relative '../../lib/liquid'
require_relative 'liquid_servlet'
require_relative 'example_servlet'
# Setup webrick
server = WEBrick::HTTPServer.new(Port: ARGV[1] || 3000)
server.mount('/', Servlet)
trap("INT") { server.shutdown }
server.start
-6
View File
@@ -1,6 +0,0 @@
<p>Hello world!</p>
<p>It is {{date}}</p>
<p>Check out the <a href="/products">Products</a> screen </p>
-49
View File
@@ -1,49 +0,0 @@
<?xml version="1.0" encoding="utf-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="Content-type" content="text/html; charset=utf-8" />
<meta http-equiv="Content-Language" content="en-us" />
<title>products</title>
<meta name="ROBOTS" content="ALL" />
<meta http-equiv="imagetoolbar" content="no" />
<meta name="MSSmartTagsPreventParsing" content="true" />
<meta name="Copyright" content="(c) 2005 Copyright content: Copyright design: Tobias Luetke" />
<!-- (c) Copyright 2005 by Tobias Luetke All Rights Reserved. -->
</head>
<body>
{% assign all_products = products | concat: more_products %}
<h1>{{ description | split: '~' | first }}</h1>
<h2>{{ description | split: '~' | last }}</h2>
<h2>There are currently {{all_products | count}} products in the {{section}} catalog</h2>
{% if cool_products %}
Cool products :)
{% else %}
Uncool products :(
{% endif %}
<ul id="products">
{% for product in all_products %}
<li>
<h2>{{product.name}}</h2>
Only {{product.price | price }}
{{product.description | prettyprint | paragraph }}
{{ 'it rocks!' | paragraph }}
</li>
{% endfor %}
</ul>
</body>
</html>
+30
View File
@@ -0,0 +1,30 @@
---
layout: null
---
<?xml version="1.0" encoding="UTF-8"?>
<rss version="2.0" xmlns:atom="http://www.w3.org/2005/Atom">
<channel>
<title>{{ site.title | xml_escape }}</title>
<description>{{ site.description | xml_escape }}</description>
<link>{{ site.url }}{{ site.baseurl }}/</link>
<atom:link href="{{ "/feed.xml" | prepend: site.baseurl | prepend: site.url }}" rel="self" type="application/rss+xml"/>
<pubDate>{{ site.time | date_to_rfc822 }}</pubDate>
<lastBuildDate>{{ site.time | date_to_rfc822 }}</lastBuildDate>
<generator>Jekyll v{{ jekyll.version }}</generator>
{% for post in site.posts limit:10 %}
<item>
<title>{{ post.title | xml_escape }}</title>
<description>{{ post.content | xml_escape }}</description>
<pubDate>{{ post.date | date_to_rfc822 }}</pubDate>
<link>{{ post.url | prepend: site.baseurl | prepend: site.url }}</link>
<guid isPermaLink="true">{{ post.url | prepend: site.baseurl | prepend: site.url }}</guid>
{% for tag in post.tags %}
<category>{{ tag | xml_escape }}</category>
{% endfor %}
{% for cat in post.categories %}
<category>{{ cat | xml_escape }}</category>
{% endfor %}
</item>
{% endfor %}
</channel>
</rss>
+44
View File
@@ -0,0 +1,44 @@
---
title: abs
description: Liquid filter that gets the absolute value of a number.
---
Returns the absolute value of a number.
<p class="code-label">Input</p>
```liquid
{% raw %}
{{ -17 | abs }}
{% endraw %}
```
<p class="code-label">Output</p>
```text
17
```
<p class="code-label">Input</p>
```liquid
{% raw %}
{{ 4 | abs }}
{% endraw %}
```
<p class="code-label">Output</p>
```text
4
```
`abs` will also work on a string if the string only contains a number.
<p class="code-label">Input</p>
```liquid
{% raw %}
{{ "-19.86" | abs }}
{% endraw %}
```
<p class="code-label">Output</p>
```text
19.86
```
+34
View File
@@ -0,0 +1,34 @@
---
title: append
description: Liquid filter that appends a string to another string.
---
Concatenates two strings and returns the concatenated value.
<p class="code-label">Input</p>
```liquid
{% raw %}
{{ "/my/fancy/url" | append: ".html" }}
{% endraw %}
```
<p class="code-label">Output</p>
```text
{{ "/my/fancy/url" | append: ".html" }}
```
`append` can also be used with variables:
<p class="code-label">Input</p>
```liquid
{% raw %}
{% assign filename = "/index.html" %}
{{ "website.com" | append: filename }}
{% endraw %}
```
<p class="code-label">Output</p>
```text
{% assign filename = "/index.html" %}
{{ "website.com" | append: filename }}
```
+32
View File
@@ -0,0 +1,32 @@
---
title: capitalize
description: Liquid filter that capitalizes the first character in a string.
---
Makes the first character of a string capitalized.
<p class="code-label">Input</p>
```liquid
{% raw %}
{{ "title" | capitalize }}
{% endraw %}
```
<p class="code-label">Output</p>
```text
Title
```
`capitalize` only capitalizes the first character of the string, so later words are not affected:
<p class="code-label">Input</p>
```liquid
{% raw %}
{{ "my great title" | capitalize }}
{% endraw %}
```
<p class="code-label">Output</p>
```text
My great title
```
+56
View File
@@ -0,0 +1,56 @@
---
title: ceil
description: Liquid filter that gets 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.
<p class="code-label">Input</p>
```liquid
{% raw %}
{{ 1.2 | ceil }}
{% endraw %}
```
<p class="code-label">Output</p>
```text
{{ 1.2 | ceil }}
```
<p class="code-label">Input</p>
```liquid
{% raw %}
{{ 2.0 | ceil }}
{% endraw %}
```
<p class="code-label">Output</p>
```text
{{ 2.0 | ceil }}
```
<p class="code-label">Input</p>
```liquid
{% raw %}
{{ 183.357 | ceil }}
{% endraw %}
```
<p class="code-label">Output</p>
```text
{{ 183.357 | ceil }}
```
Here the input value is a string:
<p class="code-label">Input</p>
```liquid
{% raw %}
{{ "3.5" | ceil }}
{% endraw %}
```
<p class="code-label">Output</p>
```text
{{ "3.5" | ceil }}
```
+53
View File
@@ -0,0 +1,53 @@
---
title: compact
description: Liquid filter that removes nil values from an array.
---
Removes any `nil` values from an array.
For this example, assume `site.pages` is an array of content pages for a website, and some of these pages have an attribute called `category` that specifies their content category. If we `map` those categories to an array, some of the array items might be `nil` if any pages do not have a `category` attribute.
<p class="code-label">Input</p>
{% raw %}
```liquid
{% assign site_categories = site.pages | map: 'category' %}
{% for category in site_categories %}
{{ category }}
{% endfor %}
```
{% endraw %}
<p class="code-label">Output</p>
```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.
<p class="code-label">Input</p>
{% raw %}
```liquid
{% assign site_categories = site.pages | map: 'category' | compact %}
{% for category in site_categories %}
{{ category }}
{% endfor %}
```
{% endraw %}
<p class="code-label">Output</p>
```text
business
celebrities
lifestyle
sports
technology
```
+60
View File
@@ -0,0 +1,60 @@
---
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).
<p class="code-label">Input</p>
```liquid
{% raw %}
{{ article.published_at | date: "%a, %b %d, %y" }}
{% endraw %}
```
<p class="code-label">Output</p>
```text
Fri, Jul 17, 15
```
<p class="code-label">Input</p>
```liquid
{% raw %}
{{ article.published_at | date: "%Y" }}
{% endraw %}
```
<p class="code-label">Output</p>
```text
2015
```
`date` works on strings if they contain well-formatted dates:
<p class="code-label">Input</p>
```liquid
{% raw %}
{{ "March 14, 2016" | date: "%b %d, %y" }}
{% endraw %}
```
<p class="code-label">Output</p>
```text
{{ "March 14, 2016" | date: "%b %d, %y" }}
```
To get the current time, pass the special word `"now"` (or `"today"`) to `date`:
<p class="code-label">Input</p>
```liquid
{% raw %}
This page was last updated at {{ "now" | date: "%Y-%m-%d %H:%M" }}.
{% endraw %}
```
<p class="code-label">Output</p>
```text
This page was last updated at {{ "now" | date: "%Y-%m-%d %H:%M" }}.
```
Note that the value will be the current time of when the page was last generated from the template, not when the page is presented to a user if caching or static site generation is involved.
+50
View File
@@ -0,0 +1,50 @@
---
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.
In this example, `product_price` is not defined, so the default value is used.
<p class="code-label">Input</p>
```liquid
{% raw %}
{{ product_price | default: 2.99 }}
{% endraw %}
```
<p class="code-label">Output</p>
```text
2.99
```
In this example, `product_price` is defined, so the default value is not used.
<p class="code-label">Input</p>
```liquid
{% raw %}
{% assign product_price = 4.99 %}
{{ product_price | default: 2.99 }}
{% endraw %}
```
<p class="code-label">Output</p>
```text
4.99
```
In this example, `product_price` is empty, so the default value is used.
<p class="code-label">Input</p>
```liquid
{% raw %}
{% assign product_price = "" %}
{{ product_price | default: 2.99 }}
{% endraw %}
```
<p class="code-label">Output</p>
```text
2.99
```
+102
View File
@@ -0,0 +1,102 @@
---
title: divided_by
description: Liquid filter that divides a number by another number.
---
Divides a number by the specified number.
The result is rounded down to the nearest integer (that is, the [floor]({{ site.baseurl }}/filters/floor)) if the divisor is an integer.
<p class="code-label">Input</p>
{% raw %}
``` liquid
{{ 16 | divided_by: 4 }}
```
{% endraw %}
<p class="code-label">Output</p>
``` text
{{ 16 | divided_by: 4 }}
```
<p class="code-label">Input</p>
{% raw %}
``` liquid
{{ 5 | divided_by: 3 }}
```
{% endraw %}
<p class="code-label">Output</p>
``` text
{{ 5 | divided_by: 3 }}
```
### Controlling rounding
`divided_by` produces a result of the same type as the divisor — that is, if you divide by an integer, the result will be an integer. If you divide by a float (a number with a decimal in it), the result will be a float.
For example, here the divisor is an integer:
<p class="code-label">Input</p>
{% raw %}
``` liquid
{{ 20 | divided_by: 7 }}
```
{% endraw %}
<p class="code-label">Output</p>
``` text
{{ 20 | divided_by: 7 }}
```
Here it is a float:
<p class="code-label">Input</p>
{% raw %}
``` liquid
{{ 20 | divided_by: 7.0 }}
```
{% endraw %}
<p class="code-label">Output</p>
``` text
{{ 20 | divided_by: 7.0 }}
```
### Changing variable types
You might want to use a variable as a divisor, in which case you can't simply add `.0` to convert it to a float. In these cases, you can `assign` a version of your variable converted to a float using the `times` filter.
In this example, we're dividing by a variable that contains an integer, so we get an integer:
<p class="code-label">Input</p>
{% raw %}
``` liquid
{% assign my_integer = 7 %}
{{ 20 | divided_by: my_integer }}
```
{% endraw %}
<p class="code-label">Output</p>
``` text
{% assign my_integer = 7 %}
{{ 20 | divided_by: my_integer }}
```
Here, we [multiply]({{ site.baseurl}}/filters/times) the variable by `1.0` to get a float, then divide by the float instead:
<p class="code-label">Input</p>
{% raw %}
``` liquid
{% assign my_integer = 7 %}
{% assign my_float = my_integer | times: 1.0 %}
{{ 20 | divided_by: my_float }}
```
{% endraw %}
<p class="code-label">Output</p>
``` text
{% assign my_integer = 7 %}
{% assign my_float = my_integer | times: 1.0 %}
{{ 20 | divided_by: my_float }}
```
+30
View File
@@ -0,0 +1,30 @@
---
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.
<p class="code-label">Input</p>
```liquid
{% raw %}
{{ "Parker Moore" | downcase }}
{% endraw %}
```
<p class="code-label">Output</p>
```text
{{ "Parker Moore" | downcase }}
```
<p class="code-label">Input</p>
```liquid
{% raw %}
{{ "apple" | downcase }}
{% endraw %}
```
<p class="code-label">Output</p>
```text
{{ "apple" | downcase }}
```
+30
View File
@@ -0,0 +1,30 @@
---
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.
<p class="code-label">Input</p>
```liquid
{% raw %}
{{ "Have you read 'James & the Giant Peach'?" | escape }}
{% endraw %}
```
<p class="code-label">Output</p>
```text
{{ "Have you read 'James & the Giant Peach'?" | escape }}
```
<p class="code-label">Input</p>
```liquid
{% raw %}
{{ "Tetsuro Takara" | escape }}
{% endraw %}
```
<p class="code-label">Output</p>
```text
{{ "Tetsuro Takara" | escape }}
```
+30
View File
@@ -0,0 +1,30 @@
---
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.
<p class="code-label">Input</p>
```liquid
{% raw %}
{{ "1 < 2 & 3" | escape_once }}
{% endraw %}
```
<p class="code-label">Output</p>
```text
{{ "1 < 2 & 3" | escape_once }}
```
<p class="code-label">Input</p>
```liquid
{% raw %}
{{ "1 &lt; 2 &amp; 3" | escape_once }}
{% endraw %}
```
<p class="code-label">Output</p>
```text
{{ "1 &lt; 2 &amp; 3" | escape_once }}
```
+38
View File
@@ -0,0 +1,38 @@
---
title: first
description: Liquid filter that returns the first item of an array.
---
Returns the first item of an array.
<p class="code-label">Input</p>
```liquid
{% raw %}
{% assign my_array = "apples, oranges, peaches, plums" | split: ", " %}
{{ my_array.first }}
{% endraw %}
```
<p class="code-label">Output</p>
```text
{% assign my_array = "apples, oranges, peaches, plums" | split: ", " %}
{{ my_array.first }}
```
<p class="code-label">Input</p>
```liquid
{% raw %}
{% assign my_array = "zebra, octopus, giraffe, tiger" | split: ", " %}
{{ my_array.first }}
{% endraw %}
```
<p class="code-label">Output</p>
```text
{% assign my_array = "zebra, octopus, giraffe, tiger" | split: ", " %}
{{ my_array.first }}
```
+56
View File
@@ -0,0 +1,56 @@
---
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.
<p class="code-label">Input</p>
```liquid
{% raw %}
{{ 1.2 | floor }}
{% endraw %}
```
<p class="code-label">Output</p>
```text
{{ 1.2 | floor }}
```
<p class="code-label">Input</p>
```liquid
{% raw %}
{{ 2.0 | floor }}
{% endraw %}
```
<p class="code-label">Output</p>
```text
{{ 2.0 | floor }}
```
<p class="code-label">Input</p>
```liquid
{% raw %}
{{ 183.357 | floor }}
{% endraw %}
```
<p class="code-label">Output</p>
```text
{{ 183.357 | floor }}
```
Here the input value is a string:
<p class="code-label">Input</p>
```liquid
{% raw %}
{{ "3.5" | floor }}
{% endraw %}
```
<p class="code-label">Output</p>
```text
{{ "3.5" | floor }}
```
+3
View File
@@ -0,0 +1,3 @@
---
redirect_to: /liquid/filters/abs
---
+22
View File
@@ -0,0 +1,22 @@
---
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.
<p class="code-label">Input</p>
```liquid
{% raw %}
{% assign beatles = "John, Paul, George, Ringo" | split: ", " %}
{{ beatles | join: " and " }}
{% endraw %}
```
<p class="code-label">Output</p>
```text
{% assign beatles = "John, Paul, George, Ringo" | split: ", " %}
{{ beatles | join: " and " }}
```
+38
View File
@@ -0,0 +1,38 @@
---
title: last
description: Liquid filter that gets the last value in an array.
---
Returns the last item of an array.
<p class="code-label">Input</p>
```liquid
{% raw %}
{% assign my_array = "apples, oranges, peaches, plums" | split: ", " %}
{{ my_array.last }}
{% endraw %}
```
<p class="code-label">Output</p>
```text
{% assign my_array = "apples, oranges, peaches, plums" | split: ", " %}
{{ my_array.last }}
```
<p class="code-label">Input</p>
```liquid
{% raw %}
{% assign my_array = "zebra, octopus, giraffe, tiger" | split: ", " %}
{{ my_array.last }}
{% endraw %}
```
<p class="code-label">Output</p>
```text
{% assign my_array = "zebra, octopus, giraffe, tiger" | split: ", " %}
{{ my_array.last }}
```
+18
View File
@@ -0,0 +1,18 @@
---
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.
<p class="code-label">Input</p>
```liquid
{% raw %}
{{ " So much room for activities! " | lstrip }}
{% endraw %}
```
<p class="code-label">Output</p>
```text
{{ " So much room for activities! " | lstrip }}
```
+28
View File
@@ -0,0 +1,28 @@
---
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.
In this example, assume the object `site.pages` contains all the metadata for a website. Using `assign` with the `map` filter creates a variable that contains only the values of the `category` properties of everything in the `site.pages` object.
<p class="code-label">Input</p>
```liquid
{% raw %}
{% assign all_categories = site.pages | map: "category" %}
{% for item in all_categories %}
{{ item }}
{% endfor %}
{% endraw %}
```
<p class="code-label">Output</p>
```text
business
celebrities
lifestyle
sports
technology
```
+42
View File
@@ -0,0 +1,42 @@
---
title: minus
description: Liquid filter that subtracts one number from another.
---
Subtracts a number from another number.
<p class="code-label">Input</p>
```liquid
{% raw %}
{{ 4 | minus: 2 }}
{% endraw %}
```
<p class="code-label">Output</p>
```text
{{ 4 | minus: 2 }}
```
<p class="code-label">Input</p>
```liquid
{% raw %}
{{ 16 | minus: 4 }}
{% endraw %}
```
<p class="code-label">Output</p>
```text
{{ 16 | minus: 4 }}
```
<p class="code-label">Input</p>
```liquid
{% raw %}
{{ 183.357 | minus: 12 }}
{% endraw %}
```
<p class="code-label">Output</p>
```text
{{ 183.357 | minus: 12 }}
```
+42
View File
@@ -0,0 +1,42 @@
---
title: modulo
description: Liquid filter that returns the remainder from a division operation.
---
Returns the remainder of a division operation.
<p class="code-label">Input</p>
```liquid
{% raw %}
{{ 3 | modulo: 2 }}
{% endraw %}
```
<p class="code-label">Output</p>
```text
{{ 3 | modulo: 2 }}
```
<p class="code-label">Input</p>
```liquid
{% raw %}
{{ 24 | modulo: 7 }}
{% endraw %}
```
<p class="code-label">Output</p>
```text
{{ 24 | modulo: 7 }}
```
<p class="code-label">Input</p>
```liquid
{% raw %}
{{ 183.357 | modulo: 12 }}
{% endraw %}
```
<p class="code-label">Output</p>
```text
{{ 183.357 | modulo: 12 }}
```
+28
View File
@@ -0,0 +1,28 @@
---
title: newline_to_br
description: Liquid filter that converts newlines in an input string to HTML <br> tags.
---
Replaces every newline (`\n`) with an HTML line break (`<br>`).
<p class="code-label">Input</p>
```liquid
{% raw %}
{% capture string_with_newlines %}
Hello
there
{% endcapture %}
{{ string_with_newlines | newline_to_br }}
{% endraw %}
```
<p class="code-label">Output</p>
```html
{% capture string_with_newlines %}
Hello
there
{% endcapture %}
{{ string_with_newlines | newline_to_br }}
```
+42
View File
@@ -0,0 +1,42 @@
---
title: plus
description: Liquid filter that adds a number to another number.
---
Adds a number to another number.
<p class="code-label">Input</p>
```liquid
{% raw %}
{{ 4 | plus: 2 }}
{% endraw %}
```
<p class="code-label">Output</p>
```text
{{ 4 | plus: 2 }}
```
<p class="code-label">Input</p>
```liquid
{% raw %}
{{ 16 | plus: 4 }}
{% endraw %}
```
<p class="code-label">Output</p>
```text
{{ 16 | plus: 4 }}
```
<p class="code-label">Input</p>
```liquid
{% raw %}
{{ 183.357 | plus: 12 }}
{% endraw %}
```
<p class="code-label">Output</p>
```text
{{ 183.357 | plus: 12 }}
```
+36
View File
@@ -0,0 +1,36 @@
---
title: prepend
description: Liquid filter that prepends a string to the beginning of another string.
---
Adds the specified string to the beginning of another string.
<p class="code-label">Input</p>
```liquid
{% raw %}
{{ "apples, oranges, and bananas" | prepend: "Some fruit: " }}
{% endraw %}
```
<p class="code-label">Output</p>
```text
{{ "apples, oranges, and bananas" | prepend: "Some fruit: " }}
```
You can also `prepend` variables:
<p class="code-label">Input</p>
```liquid
{% raw %}
{% assign url = "liquidmarkup.com" %}
{{ "/index.html" | prepend: url }}
{% endraw %}
```
<p class="code-label">Output</p>
```text
{% assign url = "liquidmarkup.com" %}
{{ "/index.html" | prepend: url }}
```
+18
View File
@@ -0,0 +1,18 @@
---
title: remove
description: Liquid filter that removes all occurences of a given substring from a string.
---
Removes every occurrence of the specified substring from a string.
<p class="code-label">Input</p>
```liquid
{% raw %}
{{ "I strained to see the train through the rain" | remove: "rain" }}
{% endraw %}
```
<p class="code-label">Output</p>
```text
{{ "I strained to see the train through the rain" | remove: "rain" }}
```
+18
View File
@@ -0,0 +1,18 @@
---
title: remove_first
description: Liquid filter that removes the first occurence of a given substring from a string.
---
Removes only the first occurrence of the specified substring from a string.
<p class="code-label">Input</p>
```liquid
{% raw %}
{{ "I strained to see the train through the rain" | remove_first: "rain" }}
{% endraw %}
```
<p class="code-label">Output</p>
```text
{{ "I strained to see the train through the rain" | remove_first: "rain" }}
```
+18
View File
@@ -0,0 +1,18 @@
---
title: replace
description: Liquid filter that replaces all occurences of a given substring in a string.
---
Replaces every occurrence of an argument in a string with the second argument.
<p class="code-label">Input</p>
```liquid
{% raw %}
{{ "Take my protein pills and put my helmet on" | replace: "my", "your" }}
{% endraw %}
```
<p class="code-label">Output</p>
```text
{{ "Take my protein pills and put my helmet on" | replace: "my", "your" }}
```
+20
View File
@@ -0,0 +1,20 @@
---
title: replace_first
description: Liquid filter that replaces the first occurrence of a given substring in a string.
---
Replaces only the first occurrence of the first argument in a string with the second argument.
<p class="code-label">Input</p>
```liquid
{% raw %}
{% assign my_string = "Take my protein pills and put my helmet on" %}
{{ my_string | replace_first: "my", "your" }}
{% endraw %}
```
<p class="code-label">Output</p>
```text
{% assign my_string = "Take my protein pills and put my helmet on" %}
{{ my_string | replace_first: "my", "your" }}
```
+36
View File
@@ -0,0 +1,36 @@
---
title: reverse
description: Liquid filter that reverses an array, or a string converted to an array.
---
Reverses the order of the items in an array. `reverse` cannot reverse a string.
<p class="code-label">Input</p>
```liquid
{% raw %}
{% assign my_array = "apples, oranges, peaches, plums" | split: ", " %}
{{ my_array | reverse | join: ", " }}
{% endraw %}
```
<p class="code-label">Output</p>
```text
{% assign my_array = "apples, oranges, peaches, plums" | split: ", " %}
{{ my_array | reverse | join: ", " }}
```
`reverse` cannot be used directly on a string, but you can split a string into an array, reverse the array, and rejoin it by chaining together filters:
<p class="code-label">Input</p>
```liquid
{% raw %}
{{ "Ground control to Major Tom." | split: "" | reverse | join: "" }}
{% endraw %}
```
<p class="code-label">Output</p>
```text
{{ "Ground control to Major Tom." | split: "" | reverse | join: "" }}
```
+42
View File
@@ -0,0 +1,42 @@
---
title: round
description: Liquid filter that rounds a number to the nearest integer.
---
Rounds an input number to the nearest integer or, if a number is specified as an argument, to that number of decimal places.
<p class="code-label">Input</p>
```liquid
{% raw %}
{{ 1.2 | round }}
{% endraw %}
```
<p class="code-label">Output</p>
```text
{{ 1.2 | round }}
```
<p class="code-label">Input</p>
```liquid
{% raw %}
{{ 2.7 | round }}
{% endraw %}
```
<p class="code-label">Output</p>
```text
{{ 2.7 | round }}
```
<p class="code-label">Input</p>
```liquid
{% raw %}
{{ 183.357 | round: 2 }}
{% endraw %}
```
<p class="code-label">Output</p>
```text
{{ 183.357 | round: 2 }}
```
+18
View File
@@ -0,0 +1,18 @@
---
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.
<p class="code-label">Input</p>
```liquid
{% raw %}
{{ " So much room for activities! " | rstrip }}
{% endraw %}
```
<p class="code-label">Output</p>
```text
{{ " So much room for activities! " | rstrip }}
```
+44
View File
@@ -0,0 +1,44 @@
---
title: size
description: Liquid filter that returns the number of characters in a string or the number of items in an array.
---
Returns the number of characters in a string or the number of items in an array. `size` can also be used with dot notation (for example, `{% raw %}{{ my_string.size }}{% endraw %}`). This allows you to use `size` inside tags such as conditionals.
<p class="code-label">Input</p>
```liquid
{% raw %}
{{ "Ground control to Major Tom." | size }}
{% endraw %}
```
<p class="code-label">Output</p>
```text
{{ "Ground control to Major Tom." | size }}
```
<p class="code-label">Input</p>
```liquid
{% raw %}
{% assign my_array = "apples, oranges, peaches, plums" | split: ", " %}
{{ my_array | size }}
{% endraw %}
```
<p class="code-label">Output</p>
```text
{% assign my_array = "apples, oranges, peaches, plums" | split: ", " %}
{{ my_array | size }}
```
Using dot notation:
```liquid
{% raw %}
{% if site.pages.size > 10 %}
This is a big website!
{% endif %}
{% endraw %}
```
+58
View File
@@ -0,0 +1,58 @@
---
title: slice
description: Liquid filter that returns a substring from a given position in a string.
---
Returns a substring of 1 character beginning at the index specified by the argument passed in. An optional second argument specifies the length of the substring to be returned.
String indices are numbered starting from 0.
<p class="code-label">Input</p>
```liquid
{% raw %}
{{ "Liquid" | slice: 0 }}
{% endraw %}
```
<p class="code-label">Output</p>
```text
{{ "Liquid" | slice: 0 }}
```
<p class="code-label">Input</p>
```liquid
{% raw %}
{{ "Liquid" | slice: 2 }}
{% endraw %}
```
<p class="code-label">Output</p>
```text
{{ "Liquid" | slice: 2 }}
```
<p class="code-label">Input</p>
```liquid
{% raw %}
{{ "Liquid" | slice: 2, 5 }}
{% endraw %}
```
<p class="code-label">Output</p>
```text
{{ "Liquid" | slice: 2, 5 }}
```
If the first parameter is a negative number, the indices are counted from the end of the string:
<p class="code-label">Input</p>
```liquid
{% raw %}
{{ "Liquid" | slice: -3, 2 }}
{% endraw %}
```
<p class="code-label">Output</p>
```text
{{ "Liquid" | slice: -3, 2 }}
```
+22
View File
@@ -0,0 +1,22 @@
---
title: sort
description: Liquid filter that sorts an array in case-sensitive order.
---
Sorts items in an array by a property of an item in the array. The order of the sorted array is case-sensitive.
<p class="code-label">Input</p>
```liquid
{% raw %}
{% assign my_array = "zebra, octopus, giraffe, Sally Snake" | split: ", " %}
{{ my_array | sort | join: ", " }}
{% endraw %}
```
<p class="code-label">Output</p>
```text
{% assign my_array = "zebra, octopus, giraffe, Sally Snake" | split: ", " %}
{{ my_array | sort | join: ", " }}
```
+20
View File
@@ -0,0 +1,20 @@
---
title: sort_natural
description: Liquid filter that sorts an array in case-insensitive order.
---
Sorts items in an array by a property of an item in the array.
<p class="code-label">Input</p>
```liquid
{% raw %}
{% assign my_array = "zebra, octopus, giraffe, Sally Snake" | split: ", " %}
{{ my_array | sort_natural | join: ", " }}
{% endraw %}
```
<p class="code-label">Output</p>
```text
giraffe, octopus, Sally Snake, zebra
```
+26
View File
@@ -0,0 +1,26 @@
---
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.
<p class="code-label">Input</p>
```liquid
{% raw %}
{% assign beatles = "John, Paul, George, Ringo" | split: ", " %}
{% for member in beatles %}
{{ member }}
{% endfor %}
{% endraw %}
```
<p class="code-label">Output</p>
```text
{% assign beatles = "John, Paul, George, Ringo" | split: ", " %}
{% for member in beatles %}
{{ member }}
{% endfor %}
```
+18
View File
@@ -0,0 +1,18 @@
---
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.
<p class="code-label">Input</p>
```liquid
{% raw %}
{{ " So much room for activities! " | strip }}
{% endraw %}
```
<p class="code-label">Output</p>
```text
{{ " So much room for activities! " | strip }}
```
+18
View File
@@ -0,0 +1,18 @@
---
title: strip_html
description: Liquid filter that removes HTML tags from a string.
---
Removes any HTML tags from a string.
<p class="code-label">Input</p>
```liquid
{% raw %}
{{ "Have <em>you</em> read <strong>Ulysses</strong>?" | strip_html }}
{% endraw %}
```
<p class="code-label">Output</p>
```text
{{ "Have <em>you</em> read <strong>Ulysses</strong>?" | strip_html }}
```
+28
View File
@@ -0,0 +1,28 @@
---
title: strip_newlines
description: Liquid filter that removes newline characters from a string.
---
Removes any newline characters (line breaks) from a string.
<p class="code-label">Input</p>
```liquid
{% raw %}
{% capture string_with_newlines %}
Hello
there
{% endcapture %}
{{ string_with_newlines | strip_newlines }}
{% endraw %}
```
<p class="code-label">Output</p>
```html
{% capture string_with_newlines %}
Hello
there
{% endcapture %}
{{ string_with_newlines | strip_newlines }}
```
+42
View File
@@ -0,0 +1,42 @@
---
title: times
description: Liquid filter that multiplies a number by another number.
---
Multiplies a number by another number.
<p class="code-label">Input</p>
```liquid
{% raw %}
{{ 3 | times: 2 }}
{% endraw %}
```
<p class="code-label">Output</p>
```text
{{ 3 | times: 2 }}
```
<p class="code-label">Input</p>
```liquid
{% raw %}
{{ 24 | times: 7 }}
{% endraw %}
```
<p class="code-label">Output</p>
```text
{{ 24 | times: 7 }}
```
<p class="code-label">Input</p>
```liquid
{% raw %}
{{ 183.357 | times: 12 }}
{% endraw %}
```
<p class="code-label">Output</p>
```text
{{ 183.357 | times: 12 }}
```
+52
View File
@@ -0,0 +1,52 @@
---
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.
<p class="code-label">Input</p>
```liquid
{% raw %}
{{ "Ground control to Major Tom." | truncate: 20 }}
{% endraw %}
```
<p class="code-label">Output</p>
```text
{{ "Ground control to Major Tom." | truncate: 20 }}
```
### Custom ellipsis
`truncate` takes an optional second parameter that specifies the sequence of characters to be appended to the truncated string. By default this is an ellipsis (...), but you can specify a different sequence.
The length of the second parameter counts against the number of characters specified by the first parameter. For example, if you want to truncate a string to exactly 10 characters, and use a 3-character ellipsis, use **13** for the first parameter of `truncate`, since the ellipsis counts as 3 characters.
<p class="code-label">Input</p>
{% raw %}
``` liquid
{{ "Ground control to Major Tom." | truncate: 25, ", and so on" }}
```
{% endraw %}
<p class="code-label">Output</p>
``` text
{{ "Ground control to Major Tom." | truncate: 25, ", and so on" }}
```
### No ellipsis
You can truncate to the exact number of characters specified by the first parameter and show no trailing characters by passing a blank string as the second parameter:
<p class="code-label">Input</p>
{% raw %}
``` liquid
{{ "Ground control to Major Tom." | truncate: 20, "" }}
```
{% endraw %}
<p class="code-label">Output</p>
``` text
{{ "Ground control to Major Tom." | truncate: 20, "" }}
```
+50
View File
@@ -0,0 +1,50 @@
---
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.
<p class="code-label">Input</p>
```liquid
{% raw %}
{{ "Ground control to Major Tom." | truncatewords: 3 }}
{% endraw %}
```
<p class="code-label">Output</p>
```text
{{ "Ground control to Major Tom." | truncatewords: 3 }}
```
### Custom ellipsis
`truncatewords` takes an optional second parameter that specifies the sequence of characters to be appended to the truncated string. By default this is an ellipsis (...), but you can specify a different sequence.
<p class="code-label">Input</p>
{% raw %}
``` liquid
{{ "Ground control to Major Tom." | truncatewords: 3, "--" }}
```
{% endraw %}
<p class="code-label">Output</p>
``` text
{{ "Ground control to Major Tom." | truncatewords: 3, "--" }}
```
### No ellipsis
You can avoid showing trailing characters by passing a blank string as the second parameter:
<p class="code-label">Input</p>
{% raw %}
``` liquid
{{ "Ground control to Major Tom." | truncatewords: 3, "" }}
```
{% endraw %}
<p class="code-label">Output</p>
``` text
{{ "Ground control to Major Tom." | truncatewords: 3, "" }}
```
+22
View File
@@ -0,0 +1,22 @@
---
title: uniq
description: Liquid filter that removes duplicate items from an array.
---
Removes any duplicate elements in an array.
<p class="code-label">Input</p>
```liquid
{% raw %}
{% assign my_array = "ants, bugs, bees, bugs, ants" | split: ", " %}
{{ my_array | uniq | join: ", " }}
{% endraw %}
```
<p class="code-label">Output</p>
```text
{% assign my_array = "ants, bugs, bees, bugs, ants" | split: ", " %}
{{ my_array | uniq | join: ", " }}
```
+30
View File
@@ -0,0 +1,30 @@
---
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.
<p class="code-label">Input</p>
```liquid
{% raw %}
{{ "Parker Moore" | upcase }}
{% endraw %}
```
<p class="code-label">Output</p>
```text
{{ "Parker Moore" | upcase }}
```
<p class="code-label">Input</p>
```liquid
{% raw %}
{{ "APPLE" | upcase }}
{% endraw %}
```
<p class="code-label">Output</p>
```text
{{ "APPLE" | upcase }}
```
+18
View File
@@ -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 }}).
<p class="code-label">Input</p>
```liquid
{% raw %}
{{ "%27Stop%21%27+said+Fred" | url_decode }}
{% endraw %}
```
<p class="code-label">Output</p>
```text
'Stop!' said Fred
```
+30
View File
@@ -0,0 +1,30 @@
---
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.
<p class="code-label">Input</p>
```liquid
{% raw %}
{{ "john@liquid.com" | url_encode }}
{% endraw %}
```
<p class="code-label">Output</p>
```text
{{ "john@liquid.com" | url_encode }}
```
<p class="code-label">Input</p>
```liquid
{% raw %}
{{ "Tetsuro Takara" | url_encode }}
{% endraw %}
```
<p class="code-label">Output</p>
```text
{{ "Tetsuro Takara" | url_encode }}
```
Binary file not shown.

After

Width:  |  Height:  |  Size: 20 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 9.0 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 1.6 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 3.9 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 30 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 27 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 18 KiB

Some files were not shown because too many files have changed in this diff Show More