Labyricorn/liquidjs
1
0
Fork 0
mirror of https://github.com/harttle/liquidjs.git synced 2026-09-15 12:20:40 -07:00
Code Issues Packages Projects Releases Wiki Activity

Deploying to gh-pages from @ harttle/liquidjs@33009bb988 🚀

Browse Source
This commit is contained in:
harttle
2022-03-02 13:23:58 +00:00
parent 235b59140b
commit 6eca272cfb
549 changed files with 2484 additions and 2446 deletions
Download Patch File Download Diff File Expand all files Collapse all files
tutorials/access-scope-in-filters.html
+1 -1
View File
@@ -115,7 +115,7 @@ engine<span class="token punctuation">.</span><span class="token function">regis
</div>
<footer class="article-footer">
<time class="article-footer-updated" datetime="2022-02-26T18:10:48.056Z" itemprop="dateModified">Last updated: 2022-02-26</time>
<time class="article-footer-updated" datetime="2022-03-02T13:22:52.817Z" itemprop="dateModified">Last updated: 2022-03-02</time>
<a href="register-filters-tags.html" class="article-footer-prev" title="Register Filters/Tags"><i class="icon-chevron-left"></i><span>Prev</span></a><a href="parse-parameters.html" class="article-footer-next" title="Parse Parameters"><span>Next</span><i class="icon-chevron-right"></i></a>
</footer>
</div>
tutorials/caching.html
+1 -1
View File
@@ -124,7 +124,7 @@ engine<span class="token punctuation">.</span><span class="token function">rende
</div>
<footer class="article-footer">
<time class="article-footer-updated" datetime="2022-02-26T18:10:48.056Z" itemprop="dateModified">Last updated: 2022-02-26</time>
<time class="article-footer-updated" datetime="2022-03-02T13:22:52.817Z" itemprop="dateModified">Last updated: 2022-03-02</time>
<a href="use-in-expressjs.html" class="article-footer-prev" title="Use in Express.js"><i class="icon-chevron-left"></i><span>Prev</span></a><a href="register-filters-tags.html" class="article-footer-next" title="Register Filters/Tags"><span>Next</span><i class="icon-chevron-right"></i></a>
</footer>
</div>
tutorials/changelog.html
+67 -64
View File
File diff suppressed because one or more lines are too long
tutorials/contribution-guidelines.html
+1 -1
View File
@@ -110,7 +110,7 @@
</div>
<footer class="article-footer">
<time class="article-footer-updated" datetime="2022-02-26T18:10:48.056Z" itemprop="dateModified">Last updated: 2022-02-26</time>
<time class="article-footer-updated" datetime="2022-03-02T13:22:52.817Z" itemprop="dateModified">Last updated: 2022-03-02</time>
<a href="differences.html" class="article-footer-prev" title="Differences with Shopify/liquid"><i class="icon-chevron-left"></i><span>Prev</span></a>
</footer>
</div>
tutorials/differences.html
+16 -3
View File
@@ -93,7 +93,20 @@
</header>
<div class="article-content" itemprop="articleBody">
<p>All filters and tags in <a target="_blank" rel="noopener external nofollow noreferrer" href="https://github.com/Shopify/liquid">shopify/liquid</a> are supposed to be built in LiquidJS, but not those business-logic specific tags/filters which are typically from Shopify themes (see <a href="./plugins.html#Plugin-List">Plugins List</a> in case you’re looking for them and feel free to add yours to the list). Though being compatible the Ruby version is one of our priorities, there are still some differences:</p>
<h2 id="Compatibility" class="article-heading"><a href="#Compatibility" class="headerlink" title="Compatibility"></a>Compatibility<a class="article-anchor" href="#Compatibility" aria-hidden="true"></a></h2><p>Being compatible the Ruby version is one of our priorities. Liquid language is originally <a target="_blank" rel="noopener external nofollow noreferrer" href="https://github.com/Shopify/liquid">implemented in Ruby</a> and used by Shopify, Jekyll and thus Github Pages, as you can see it’s one of the most popular template engines in Ruby. There’re lots of people using LiquidJS to serve their templates originally written for Shopify themes and Jekyll sites.</p>
<p>So “being compatible” means serve developers from Shopify and Jekyll well:</p>
<ul>
<li><strong>Well-formed Liquid template should work just fine in LiquidJS</strong>. For example, <code>forloop.index</code> should be 1-indexed, <code>nil</code> should be rendered as empty string rather than <code>undefined</code>, etc. Although some features (e.g. <a target="_blank" rel="noopener external nofollow noreferrer" href="https://github.com/harttle/liquidjs/issues/236">#236</a>) are not feasible in JavaScript, at least we’re trying to implement all the semantics of Liquid language.</li>
<li><strong>All filters and tags in <a target="_blank" rel="noopener external nofollow noreferrer" href="https://github.com/Shopify/liquid">shopify/liquid</a> are supposed to be built in LiquidJS</strong>. But not those business-logic specific tags/filters typically defined by Shopify platform. Those features should be maintained as <a href="./plugins.html#Plugin-List">plugins</a>. For filters/tags that are not business-logic specific, like <code>&#123;% layout %&#125;</code>, and extremely useful, feel free to file an issue.</li>
</ul>
<p>In the meantime, it’s now implemented in JavaScript, that means it has to be more powerful:</p>
<ul>
<li><strong>Async as first-class citizen</strong>. Filters and tags can be implemented asynchronously by return a <code>Promise</code>.</li>
<li><strong>Also can be sync</strong>. For scenarios that are not I/O intensive, render synchronously can be much faster. You can call synchronous APIs like <code>.renderSync()</code> as long as all the filters and tags in template support to be rendered synchronously. All builtin filters/tags support both sync and async render.</li>
<li><strong><a href="https://liquidjs.com/tutorials/render-file.html#Abstract-File-System">Abstract file system</a></strong>. Along with async feature, LiquidJS can be used to serve templates stored in Databases <a target="_blank" rel="noopener external nofollow noreferrer" href="https://github.com/harttle/liquidjs/discussions/414">#414</a>, on remote HTTP server <a target="_blank" rel="noopener external nofollow noreferrer" href="https://github.com/harttle/liquidjs/discussions/485">#485</a>, and so on.</li>
<li><strong>Additional tags and filters</strong> like <code>layout</code> and <code>json</code>.</li>
</ul>
<h2 id="Differences" class="article-heading"><a href="#Differences" class="headerlink" title="Differences"></a>Differences<a class="article-anchor" href="#Differences" aria-hidden="true"></a></h2><p>Though we’re trying to be compatible with the Ruby version, there are still some differences:</p>
<ul>
<li>Truthy and Falsy. All values except <code>undefined</code>, <code>null</code>, <code>false</code> are truthy, whereas in Ruby Liquid all except <code>nil</code> and <code>false</code> are truthy. See <a target="_blank" rel="noopener external nofollow noreferrer" href="https://github.com/harttle/liquidjs/pull/26">#26</a>.</li>
<li>Number. In JavaScript we cannot distinguish or convert between <code>float</code> and <code>integer</code>, see <a target="_blank" rel="noopener external nofollow noreferrer" href="https://github.com/harttle/liquidjs/issues/59">#59</a>. And when applied <code>size</code> filter, numbers always return 0, which is 8 for integer in ruby, cause they do not have a <code>length</code> property.</li>
@@ -108,7 +121,7 @@
</div>
<footer class="article-footer">
<time class="article-footer-updated" datetime="2022-02-26T18:10:48.056Z" itemprop="dateModified">Last updated: 2022-02-26</time>
<time class="article-footer-updated" datetime="2022-03-02T13:22:52.817Z" itemprop="dateModified">Last updated: 2022-03-02</time>
<a href="changelog.html" class="article-footer-prev" title="Changelog"><i class="icon-chevron-left"></i><span>Prev</span></a><a href="contribution-guidelines.html" class="article-footer-next" title="Contribution Guidelines"><span>Next</span><i class="icon-chevron-right"></i></a>
</footer>
</div>
@@ -117,7 +130,7 @@
<div id="article-toc-inner">
<div id="article-toc-inner-list">
<strong class="sidebar-title">Contents</strong>
<ol class="toc"><li class="toc-item toc-level-2"><a class="toc-link" href="#Compatibility"><span class="toc-text">Compatibility</span></a></li><li class="toc-item toc-level-2"><a class="toc-link" href="#Differences"><span class="toc-text">Differences</span></a></li></ol>
</div>
<a href="#" id="article-toc-top">Back to Top</a>
</div>
tutorials/intro-to-liquid.html
+1 -1
View File
@@ -126,7 +126,7 @@
</div>
<footer class="article-footer">
<time class="article-footer-updated" datetime="2022-02-26T18:10:48.056Z" itemprop="dateModified">Last updated: 2022-02-26</time>
<time class="article-footer-updated" datetime="2022-03-02T13:22:52.817Z" itemprop="dateModified">Last updated: 2022-03-02</time>
<a href="setup.html" class="article-footer-next" title="Setup"><span>Next</span><i class="icon-chevron-right"></i></a>
</footer>
</div>
tutorials/migrate-to-9.html
+1 -1
View File
@@ -117,7 +117,7 @@
</div>
<footer class="article-footer">
<time class="article-footer-updated" datetime="2022-02-26T18:10:48.056Z" itemprop="dateModified">Last updated: 2022-02-26</time>
<time class="article-footer-updated" datetime="2022-03-02T13:22:52.817Z" itemprop="dateModified">Last updated: 2022-03-02</time>
<a href="truthy-and-falsy.html" class="article-footer-prev" title="Truthy and Falsy"><i class="icon-chevron-left"></i><span>Prev</span></a><a href="changelog.html" class="article-footer-next" title="Changelog"><span>Next</span><i class="icon-chevron-right"></i></a>
</footer>
</div>
tutorials/operators.html
+1 -1
View File
@@ -107,7 +107,7 @@
</div>
<footer class="article-footer">
<time class="article-footer-updated" datetime="2022-02-26T18:10:48.056Z" itemprop="dateModified">Last updated: 2022-02-26</time>
<time class="article-footer-updated" datetime="2022-03-02T13:22:52.817Z" itemprop="dateModified">Last updated: 2022-03-02</time>
<a href="plugins.html" class="article-footer-prev" title="Plugins"><i class="icon-chevron-left"></i><span>Prev</span></a><a href="truthy-and-falsy.html" class="article-footer-next" title="Truthy and Falsy"><span>Next</span><i class="icon-chevron-right"></i></a>
</footer>
</div>
tutorials/options.html
+1 -1
View File
@@ -167,7 +167,7 @@
</div>
<footer class="article-footer">
<time class="article-footer-updated" datetime="2022-02-26T18:10:48.056Z" itemprop="dateModified">Last updated: 2022-02-26</time>
<time class="article-footer-updated" datetime="2022-03-02T13:22:52.817Z" itemprop="dateModified">Last updated: 2022-03-02</time>
<a href="setup.html" class="article-footer-prev" title="Setup"><i class="icon-chevron-left"></i><span>Prev</span></a><a href="render-file.html" class="article-footer-next" title="Render Files"><span>Next</span><i class="icon-chevron-right"></i></a>
</footer>
</div>
tutorials/parse-parameters.html
+1 -1
View File
@@ -162,7 +162,7 @@ engine<span class="token punctuation">.</span><span class="token function">regis
</div>
<footer class="article-footer">
<time class="article-footer-updated" datetime="2022-02-26T18:10:48.056Z" itemprop="dateModified">Last updated: 2022-02-26</time>
<time class="article-footer-updated" datetime="2022-03-02T13:22:52.817Z" itemprop="dateModified">Last updated: 2022-03-02</time>
<a href="access-scope-in-filters.html" class="article-footer-prev" title="Access Scope in Filters"><i class="icon-chevron-left"></i><span>Prev</span></a><a href="render-tag-content.html" class="article-footer-next" title="Render Tag Content"><span>Next</span><i class="icon-chevron-right"></i></a>
</footer>
</div>
tutorials/partials-and-layouts.html
+1 -1
View File
@@ -131,7 +131,7 @@ Footer<span aria-hidden="true" class="line-numbers-rows"><span></span><span></sp
</div>
<footer class="article-footer">
<time class="article-footer-updated" datetime="2022-02-26T18:10:48.056Z" itemprop="dateModified">Last updated: 2022-02-26</time>
<time class="article-footer-updated" datetime="2022-03-02T13:22:52.817Z" itemprop="dateModified">Last updated: 2022-03-02</time>
<a href="render-file.html" class="article-footer-prev" title="Render Files"><i class="icon-chevron-left"></i><span>Prev</span></a><a href="use-in-expressjs.html" class="article-footer-next" title="Use in Express.js"><span>Next</span><i class="icon-chevron-right"></i></a>
</footer>
</div>
tutorials/plugins.html
+1 -1
View File
@@ -122,7 +122,7 @@ engine
</div>
<footer class="article-footer">
<time class="article-footer-updated" datetime="2022-02-26T18:10:48.056Z" itemprop="dateModified">Last updated: 2022-02-26</time>
<time class="article-footer-updated" datetime="2022-03-02T13:22:52.817Z" itemprop="dateModified">Last updated: 2022-03-02</time>
<a href="whitespace-control.html" class="article-footer-prev" title="Whitespace Control"><i class="icon-chevron-left"></i><span>Prev</span></a><a href="operators.html" class="article-footer-next" title="Operators"><span>Next</span><i class="icon-chevron-right"></i></a>
</footer>
</div>
tutorials/register-filters-tags.html
+1 -1
View File
@@ -137,7 +137,7 @@ engine<span class="token punctuation">.</span><span class="token function">regis
engine<span class="token punctuation">.</span><span class="token function">registerFilter</span><span class="token punctuation">(</span><span class="token string">'plus'</span><span class="token punctuation">,</span> <span class="token function">disabledFilter</span><span class="token punctuation">(</span><span class="token string">'plus'</span><span class="token punctuation">)</span><span class="token punctuation">)</span><span class="token punctuation">;</span><span aria-hidden="true" class="line-numbers-rows"><span></span><span></span><span></span><span></span><span></span><span></span><span></span><span></span><span></span><span></span><span></span><span></span><span></span><span></span><span></span></span></code></pre>
</div>
<footer class="article-footer">
<time class="article-footer-updated" datetime="2022-02-26T18:10:48.056Z" itemprop="dateModified">Last updated: 2022-02-26</time>
<time class="article-footer-updated" datetime="2022-03-02T13:22:52.817Z" itemprop="dateModified">Last updated: 2022-03-02</time>
<a href="caching.html" class="article-footer-prev" title="Caching"><i class="icon-chevron-left"></i><span>Prev</span></a><a href="access-scope-in-filters.html" class="article-footer-next" title="Access Scope in Filters"><span>Next</span><i class="icon-chevron-right"></i></a>
</footer>
</div>
tutorials/render-file.html
+1 -1
View File
@@ -167,7 +167,7 @@ name: alice<span aria-hidden="true" class="line-numbers-rows"><span></span><span
</div>
<footer class="article-footer">
<time class="article-footer-updated" datetime="2022-02-26T18:10:48.056Z" itemprop="dateModified">Last updated: 2022-02-26</time>
<time class="article-footer-updated" datetime="2022-03-02T13:22:52.817Z" itemprop="dateModified">Last updated: 2022-03-02</time>
<a href="options.html" class="article-footer-prev" title="Options"><i class="icon-chevron-left"></i><span>Prev</span></a><a href="partials-and-layouts.html" class="article-footer-next" title="Includes and Layouts"><span>Next</span><i class="icon-chevron-right"></i></a>
</footer>
</div>
tutorials/render-tag-content.html
+1 -1
View File
@@ -189,7 +189,7 @@
</div>
<footer class="article-footer">
<time class="article-footer-updated" datetime="2022-02-26T18:10:48.056Z" itemprop="dateModified">Last updated: 2022-02-26</time>
<time class="article-footer-updated" datetime="2022-03-02T13:22:52.817Z" itemprop="dateModified">Last updated: 2022-03-02</time>
<a href="parse-parameters.html" class="article-footer-prev" title="Parse Parameters"><i class="icon-chevron-left"></i><span>Prev</span></a><a href="sync-and-async.html" class="article-footer-next" title="Sync and Async"><span>Next</span><i class="icon-chevron-right"></i></a>
</footer>
</div>
tutorials/setup.html
+1 -1
View File
@@ -140,7 +140,7 @@ engine
</div>
<footer class="article-footer">
<time class="article-footer-updated" datetime="2022-02-26T18:10:48.056Z" itemprop="dateModified">Last updated: 2022-02-26</time>
<time class="article-footer-updated" datetime="2022-03-02T13:22:52.817Z" itemprop="dateModified">Last updated: 2022-03-02</time>
<a href="intro-to-liquid.html" class="article-footer-prev" title="Intro to Liquid"><i class="icon-chevron-left"></i><span>Prev</span></a><a href="options.html" class="article-footer-next" title="Options"><span>Next</span><i class="icon-chevron-right"></i></a>
</footer>
</div>
tutorials/sync-and-async.html
+1 -1
View File
@@ -159,7 +159,7 @@ engine<span class="token punctuation">.</span><span class="token function">regis
</div>
<footer class="article-footer">
<time class="article-footer-updated" datetime="2022-02-26T18:10:48.056Z" itemprop="dateModified">Last updated: 2022-02-26</time>
<time class="article-footer-updated" datetime="2022-03-02T13:22:52.817Z" itemprop="dateModified">Last updated: 2022-03-02</time>
<a href="render-tag-content.html" class="article-footer-prev" title="Render Tag Content"><i class="icon-chevron-left"></i><span>Prev</span></a><a href="whitespace-control.html" class="article-footer-next" title="Whitespace Control"><span>Next</span><i class="icon-chevron-right"></i></a>
</footer>
</div>
tutorials/truthy-and-falsy.html
+1 -1
View File
@@ -227,7 +227,7 @@
</div>
<footer class="article-footer">
<time class="article-footer-updated" datetime="2022-02-26T18:10:48.056Z" itemprop="dateModified">Last updated: 2022-02-26</time>
<time class="article-footer-updated" datetime="2022-03-02T13:22:52.817Z" itemprop="dateModified">Last updated: 2022-03-02</time>
<a href="operators.html" class="article-footer-prev" title="Operators"><i class="icon-chevron-left"></i><span>Prev</span></a><a href="migrate-to-9.html" class="article-footer-next" title="Migrate to LiquidJS 9"><span>Next</span><i class="icon-chevron-right"></i></a>
</footer>
</div>
tutorials/use-in-expressjs.html
+1 -1
View File
@@ -135,7 +135,7 @@ res<span class="token punctuation">.</span><span class="token function">render</
</div>
<footer class="article-footer">
<time class="article-footer-updated" datetime="2022-02-26T18:10:48.056Z" itemprop="dateModified">Last updated: 2022-02-26</time>
<time class="article-footer-updated" datetime="2022-03-02T13:22:52.817Z" itemprop="dateModified">Last updated: 2022-03-02</time>
<a href="partials-and-layouts.html" class="article-footer-prev" title="Includes and Layouts"><i class="icon-chevron-left"></i><span>Prev</span></a><a href="caching.html" class="article-footer-next" title="Caching"><span>Next</span><i class="icon-chevron-right"></i></a>
</footer>
</div>
tutorials/whitespace-control.html
+1 -1
View File
@@ -122,7 +122,7 @@ harttle<span aria-hidden="true" class="line-numbers-rows"><span></span><span></s
</div>
<footer class="article-footer">
<time class="article-footer-updated" datetime="2022-02-26T18:10:48.056Z" itemprop="dateModified">Last updated: 2022-02-26</time>
<time class="article-footer-updated" datetime="2022-03-02T13:22:52.817Z" itemprop="dateModified">Last updated: 2022-03-02</time>
<a href="sync-and-async.html" class="article-footer-prev" title="Sync and Async"><i class="icon-chevron-left"></i><span>Prev</span></a><a href="plugins.html" class="article-footer-next" title="Plugins"><span>Next</span><i class="icon-chevron-right"></i></a>
</footer>
</div>