docs: add versions to tags/filters, see #305

2026-09-18 22:10:41 -07:00 · 2021-03-21 22:17:17 +08:00
parent 2133ed20d7
commit 695e3c18bc
129 changed files with 262 additions and 2 deletions
@@ -2,6 +2,8 @@
 title: abs
 ---

+{% since %}v1.9.1{% endsince %}
+
 返回数字的绝对值。

 输入
@@ -2,6 +2,8 @@
 title: append
 ---

+{% since %}v1.9.1{% endsince %}
+
 连接两个字符串并返回结果。

 输入
@@ -2,6 +2,8 @@
 title: at_least
 ---

+{% since %}v8.4.0{% endsince %}
+
 限制数字到某个最小值。

 输入
@@ -2,6 +2,8 @@
 title: at_most
 ---

+{% since %}v8.4.0{% endsince %}
+
 限制数字到某个最大值。

 输入
@@ -2,6 +2,8 @@
 title: capitalize
 ---

+{% since %}v1.9.1{% endsince %}
+
 把字符串首字母改为大写。

 输入
@@ -2,6 +2,8 @@
 title: ceil
 ---

+{% since %}v1.9.1{% endsince %}
+
 向上取整，取整前 LiquidJS 会首先把输入转换为数字。

 输入
@@ -2,6 +2,8 @@
 title: compact
 ---

+{% since %}v9.22.0{% endsince %}
+
 从数组里移除任何 `null` 和 `undefined` 值。

 假设 `site.pages` 是网页列表，有些网页包含 `category` 属性用来标明类别。如果把它们 `map` 到数组里，那么对于没有 `category` 属性的元素就会是 `undefined`。
@@ -2,6 +2,8 @@
 title: date
 ---

+{% since %}v1.9.1{% endsince %}
+
 把时间戳转换为字符串。LiquidJS 尝试跟 Shopify/Liquid 保持一致，它用的是 Ruby 核心的 [Time#strftime(string)](http://www.ruby-doc.org/core/Time.html#method-i-strftime)。此外 LiquidJS 会先通过 [new Date()][newDate] 尝试把输入转换为 Date 对象。

 输入
@@ -2,6 +2,8 @@
 title: default
 ---

+{% since %}v1.9.1{% endsince %}
+
 在值不存在时给一个默认值，如果左侧是 [falsy][falsy] 或空（`string` 或 `Array`）就会使用这个默认值。下面的例子中 `product_price` 没有定义，因此使用了默认值。

 输入
@@ -2,6 +2,8 @@
 title: divided_by
 ---

+{% since %}v1.9.1{% endsince %}
+
 两数相除返回商，返回结果数字在 JavaScript 中 `.toString()` 得到的字符串。

 输入
@@ -2,6 +2,8 @@
 title: downcase
 ---

+{% since %}v1.9.1{% endsince %}
+
 字符串中每个字符都转为小写，对已经是小写的字符没有影响。

 输入
@@ -2,6 +2,8 @@
 title: escape
 ---

+{% since %}v1.9.1{% endsince %}
+
 把字符串中的 HTML 特殊字符转义，对不需要转义的字符串不会产生影响。

 输入
@@ -2,6 +2,8 @@
 title: escape_once
 ---

+{% since %}v1.9.1{% endsince %}
+
 把字符串中的特殊字符转义得到可用在 URL 里的字符串，对已经转义过的字符串和不需要转义的字符串不会产生影响。

 输入
@@ -2,6 +2,8 @@
 title: first
 ---

+{% since %}v1.9.1{% endsince %}
+
 返回数组的第一个元素。

 输入
@@ -2,6 +2,8 @@
 title: floor
 ---

+{% since %}v1.9.1{% endsince %}
+
 数字下取整，LiquidJS 会尝试把输入转换为数字再做下取整操作。

 输入
@@ -2,6 +2,8 @@
 title: join
 ---

+{% since %}v1.9.1{% endsince %}
+
 把数组中的元素连接成为一个字符串，以传入的参数作为分隔符。

 输入
@@ -2,6 +2,8 @@
 title: json
 ---

+{% since %}v9.10.0{% endsince %}
+
 通过 `JSON.stringify()` 把值转换为字符串，多用于调试用途。

 输入
@@ -2,6 +2,8 @@
 title: last
 ---

+{% since %}v1.9.1{% endsince %}
+
 返回数组的最后一个元素。

 输入
@@ -2,6 +2,8 @@
 title: lstrip
 ---

+{% since %}v1.9.1{% endsince %}
+
 移除字符串左侧的空白字符（制表符、空格、换行），不影响词之间的空格。

 输入
@@ -2,6 +2,8 @@
 title: map
 ---

+{% since %}v1.9.1{% endsince %}
+
 按照属性名提取对象的属性形成另一个数组并返回。

 下面的例子中假设 `site.pages` 包含了站点的所有网页元信息。使用 `assign` 加 `map` 过滤器创建了一个 `site.pages` 中所有对象的 `category` 属性的值构成的数组。
@@ -2,6 +2,8 @@
 title: minus
 ---

+{% since %}v1.9.1{% endsince %}
+
 两数相减。

 输入
@@ -2,6 +2,8 @@
 title: modulo
 ---

+{% since %}v1.9.1{% endsince %}
+
 返回两数相除的余数。

 输入
@@ -2,6 +2,8 @@
 title: newline_to_br
 ---

+{% since %}v1.9.1{% endsince %}
+
 把字符串里的所有换行符（`\n`）替换为 HTML 换行（`<br />`）。

 输入
@@ -2,6 +2,8 @@
 title: plus
 ---

+{% since %}v1.9.1{% endsince %}
+
 两数相加。

 输入
@@ -2,6 +2,8 @@
 title: prepend
 ---

+{% since %}v1.9.1{% endsince %}
+
 在字符串开头添加另一个字符串。

 输入
@@ -2,6 +2,8 @@
 title: remove
 ---

+{% since %}v1.9.1{% endsince %}
+
 移除字符串中出现的所有指定子字符串。

 输入
@@ -2,6 +2,8 @@
 title: remove_first
 ---

+{% since %}v1.9.1{% endsince %}
+
 移除字符串中出现的第一个指定子字符串。

 输入
@@ -2,6 +2,8 @@
 title: replace
 ---

+{% since %}v1.9.1{% endsince %}
+
 把字符串中出现的每一个指定子字符串替换为另一个字符串。

 输入
@@ -2,6 +2,8 @@
 title: replace_first
 ---

+{% since %}v1.9.1{% endsince %}
+
 把字符串中出现的第一个指定子字符串替换为另一个字符串。

 输入
@@ -2,6 +2,8 @@
 title: reverse
 ---

+{% since %}v1.9.1{% endsince %}
+
 反转数组的所有元素，不可用于字符串。

 输入
@@ -2,6 +2,8 @@
 title: round
 ---

+{% since %}v1.9.1{% endsince %}
+
 数字四舍五入取整，如果传入小数位数作为参数。

 输入
@@ -2,6 +2,8 @@
 title: rstrip
 ---

+{% since %}v1.9.1{% endsince %}
+
 移除字符串右侧的空白字符（制表符、空格、换行），不影响词之间的空格。

 输入
@@ -2,6 +2,8 @@
 title: size
 ---

+{% since %}v1.9.1{% endsince %}
+
 返回字符串的字符个数或者数组的元素个数。

 输入
@@ -2,6 +2,8 @@
 title: slice
 ---

+{% since %}v1.9.1{% endsince %}
+
 返回第一个参数为下标位置的一个字符，如果指定了第二个参数会被解释为子字符串的长度。字符串下标从零开始。

 输入
@@ -2,6 +2,8 @@
 title: sort
 ---

+{% since %}v1.9.1{% endsince %}
+
 对数组中的元素排序，排序方式为 JavaScript `Array.prototype.sort()`。

 输入
@@ -2,6 +2,8 @@
 title: sort_natural
 ---

+{% since %}v8.4.0{% endsince %}
+
 大小写不敏感地对数组元素排序。

 输入
@@ -2,6 +2,8 @@
 title: split
 ---

+{% since %}v1.9.1{% endsince %}
+
 把字符串按照指定的分隔符进行分割，`split` 通常用于把逗号分隔的字符串转换为数组。

 输入
@@ -2,6 +2,8 @@
 title: strip
 ---

+{% since %}v1.9.1{% endsince %}
+
 移除字符串两侧的空白字符（制表符、空格、换行），不影响词之间的空格。

 输入
@@ -2,6 +2,8 @@
 title: strip_html
 ---

+{% since %}v1.9.1{% endsince %}
+
 移除字符串中的 HTML 标签。

 输入
@@ -2,6 +2,8 @@
 title: strip_newlines
 ---

+{% since %}v1.9.1{% endsince %}
+
 移除字符串中的换行符。

 输入
@@ -2,6 +2,8 @@
 title: times
 ---

+{% since %}v1.9.1{% endsince %}
+
 两数相乘。

 输入
@@ -2,6 +2,8 @@
 title: truncate
 ---

+{% since %}v1.9.1{% endsince %}
+
 把字符串截断为指定长度，可以指定一个数字表示截断到多少长度。最后会添加一个省略号（...）且记在长度里。

 ## 基本使用
@@ -2,6 +2,8 @@
 title: truncatewords
 ---

+{% since %}v1.9.1{% endsince %}
+
 把字符串截断为指定个数的单词，可以指定一个数字表示截断到多少个单词。最后会添加一个省略号（...）。

 ## 基本使用
@@ -2,6 +2,8 @@
 title: uniq
 ---

+{% since %}v1.9.1{% endsince %}
+
 移除数组中的重复元素。

 输入
@@ -2,6 +2,8 @@
 title: upcase
 ---

+{% since %}v1.9.1{% endsince %}
+
 字符串中每个字符都转为大写，对已经是小写的字符没有影响。

 输入
@@ -2,6 +2,8 @@
 title: url_decode
 ---

+{% since %}v6.1.0{% endsince %}
+
 把 URL 编码的字符串解码。

 输入
@@ -2,6 +2,8 @@
 title: url_encode
 ---

+{% since %}v1.9.1{% endsince %}
+
 把字符串中 URL 不安全的字符转义为百分号编码。

 输入
@@ -2,6 +2,8 @@
 title: where
 ---

+{% since %}v8.1.0{% endsince %}
+
 按照数组中对象的属性值来过滤得到新数组，如果未指定第二个参数（属性值）则过滤得到所有属性值为 [truthy][truthy] 的对象。

 下面的例子中，假设你有一个 `products` 列表并且希望展示其中的厨房产品。使用 `where` 过滤器可以得到一个只包含 `"type"` 属性值为 `"kitchen"` 的元素的数组。
@@ -2,6 +2,8 @@
 title: Assign
 ---

+{% since %}v1.9.1{% endsince %}
+
 创建一个新变量。

 输入
@@ -2,6 +2,8 @@
 title: capture
 ---

+{% since %}v1.9.1{% endsince %}
+
 把 `capture` 开闭标签之间的内容渲染后赋值给一个变量，这个变量的类型总是字符串。

 输入
@@ -2,6 +2,8 @@
 title: case
 ---

+{% since %}v1.9.1{% endsince %}
+
 创建一个 switch 语句，把变量跟不同的值比较。`case` 创建 switch 语句，`when` 比较它的值。

 输入
@@ -2,6 +2,8 @@
 title: Comment
 ---

+{% since %}v1.9.1{% endsince %}
+
 让 Liquid 模板里一段代码不渲染。处于 `comment` 开闭标签之间的文本都不会输出，Liquid 代码都不会执行。

 输入
@@ -2,6 +2,8 @@
 title: cycle
 ---

+{% since %}v1.9.1{% endsince %}
+
 循环一组字符串按照它们传入的顺序打印出来。每次调用 `cycle` 打印下一个参数。

 ## 基本使用
@@ -2,6 +2,8 @@
 title: Decrement
 ---

+{% since %}v1.9.1{% endsince %}
+
 创建一个新的数字类型的变量，每次调用都把它的值减一。第一次是 `-1`。

 输入
@@ -2,6 +2,8 @@
 title: For
 ---

+{% since %}v1.9.1{% endsince %}
+
 重复执行代码块的迭代标签。

 ## 基本使用
@@ -2,6 +2,8 @@
 title: If
 ---

+{% since %}v1.9.1{% endsince %}
+
 条件为 `true` 时执行某个代码块。

 ## if
@@ -2,6 +2,8 @@
 title: Include
 ---

+{% since %}v1.9.1{% endsince %}
+
 {% note warn 已废弃 %}
 这个标签已经废弃，请使用封装更好的 <a href="./render.html">render</a> 标签。
 {% endnote %}
@@ -2,6 +2,8 @@
 title: Increment
 ---

+{% since %}v1.9.1{% endsince %}
+
 创建一个新的数字类型的变量，每次调用都把它的值加一。第一次为 `0`。

 输入
@@ -2,6 +2,8 @@
 title: Layout
 ---

+{% since %}v1.9.1{% endsince %}
+
 ## 使用布局模板

 套用模板 [根路径][root] 下的某个布局模板中。
@@ -2,6 +2,8 @@
 title: Raw
 ---

+{% since %}v1.9.1{% endsince %}
+
 `raw` 标签可以暂时禁用 LiquidJS 的语法。生成和 Liquid 冲突的语言（比如 Nunjucks、Handlebars）时很有用。

 输入
@@ -2,6 +2,8 @@
 title: Render
 ---

+{% since %}v9.2.0{% endsince %}
+
 ## 基本使用

 ### 渲染一个模板
@@ -2,6 +2,8 @@
 title: Table Row
 ---

+{% since %}v1.9.1{% endsince %}
+
 生成一个 HTML 表示，上下必须用 `<table>` 和 `</table>` HTML 标签包裹起来。

 ## 基本使用
@@ -2,6 +2,8 @@
 title: Unless
 ---

+{% since %}v1.9.1{% endsince %}
+
 和 `if` 相反 —— 条件 **不满足** 时执行代码块。

 输入