chore: upgrade API doc to latest typedoc, fixes #593

This commit is contained in:
Harttle
2023-03-20 00:41:06 +08:00
committed by Jun Yang
parent c6cde9cd10
commit da93102c1c
40 changed files with 3870 additions and 7145 deletions
+6 -5
View File
@@ -47,8 +47,9 @@ engine.renderFileSync('hello', {name: 'alice'})
engine.renderFileSync('hello', {name: 'bob'})
```
[parse]: ../../api/classes/liquid_.liquid.html#parse
[parseFile]: ../../api/classes/liquid_.liquid.html#parseFile
[parseFileSync]: ../../api/classes/liquid_.liquid.html#parseFileSync
[renderFile]: ../../api/classes/liquid_.liquid.html#renderFile
[renderFileSync]: ../../api/classes/liquid_.liquid.html#renderFilesync
[parse]: /api/classes/Liquid.html#parse
[cache]: /api/interfaces/LiquidOptions.html#cache
[parseFile]: /api/classes/Liquid.html#parseFile
[parseFileSync]: /api/classes/Liquid.html#parseFileSync
[renderFile]: /api/classes/Liquid.html#renderFile
[renderFileSync]: /api/classes/Liquid.html#renderFileSync
+3 -3
View File
@@ -12,7 +12,7 @@ const engine = new Liquid({
```
{% note info API 文档 %}
下面的所有选项的概述,希望了解具体的类型和签名,请前往 <a href="https://liquidjs.com/api/interfaces/liquid_options_.liquidoptions.html" target="_self">LiquidOptions | API</a>.
下面的所有选项的概述,希望了解具体的类型和签名,请前往 <a href="https://liquidjs.com/api/interfaces/LiquidOptions.html" target="_self">LiquidOptions | API</a>.
{% endnote %}
## 缓存
@@ -136,7 +136,7 @@ LiquidJS 把这个选项默认值设为 <code>true</code> 以兼容于 shopify/l
默认会忽略参数出现的顺序,例如 `{% for i in (1..8) reversed limit:3 %}` 里总是会先执行 `limit` 再执行 `reversed`,虽然 `reversed` 先出现。为了让 LiquidJS 按顺序执行参数,需要设置 **orderedFilterParameters**`true`。它的默认值为 `false`
[liquid]: ../api/classes/liquid_.liquid.html
[liquid]: /api/classes/Liquid.html
[caching]: ./caching.html
[abstract-fs]: ./render-file.html#Abstract-File-System
[render-file]: ./render-file.html
@@ -146,4 +146,4 @@ LiquidJS 把这个选项默认值设为 <code>true</code> 以兼容于 shopify/l
[layout]: ../tags/layout.html
[wc]: ./whitespace-control.html
[intro]: ./intro-to-liquid.html
[jekyllInclude]: ../api/interfaces/liquid_options_.liquidoptions.html#Optional-jekyllInclude
[jekyllInclude]: /api/interfaces/LiquidOptions.html#jekyllInclude
@@ -96,5 +96,5 @@ engine.registerTag('random', {
`{ max: 10 }` 上下文上渲染 `{% random from:2, to:max %}` 将会得到 [2, 10] 范围内的随机数。见这个 JSFiddle<http://jsfiddle.net/ctj364up/4/>。
[register-tags]: /tutorials/register-filters-tags.html
[Tokenizer]: /api/classes/parser_tokenizer_.tokenizer.html
[Hash]: /api/classes/template_tag_hash_.hash.html
[Tokenizer]: /api/classes/Tokenizer.html
[Hash]: /api/classes/Hash.html
+1 -1
View File
@@ -45,5 +45,5 @@ engine.parseAndRender('{{ "foo" | upup }}').then(console.log)
* Sections 标签(开发中): https://github.com/harttle/liquidjs-section-tags
* 颜色过滤器: https://github.com/harttle/liquidjs-color-filters
[liquid]: ../../api/classes/liquid_.liquid.html
[liquid]: /api/classes/Liquid.html
[register]: ./register-filters-tags.html
+9 -9
View File
@@ -100,14 +100,14 @@ const engine = new Liquid({
});
```
[fs]: ../../api/interfaces/liquid_options_.liquidoptions.html#Optional-fs
[ifs]: https://github.com/harttle/liquidjs/blob/master/src/fs/ifs.ts
[fs-node]: https://github.com/harttle/liquidjs/blob/master/src/fs/node.ts
[fs-browser]: https://github.com/harttle/liquidjs/blob/master/src/fs/browser.ts
[fs]: /api/interfaces/LiquidOptions.html#fs
[ifs]: /api/interfaces/FS.html
[fs-node]: https://github.com/harttle/liquidjs/blob/master/src/fs/fs-impl.ts
[fs-browser]: https://github.com/harttle/liquidjs/blob/master/src/fs/fs-impl-browser.ts
[layout]: https://help.shopify.com/en/themes/liquid/tags/theme-tags#layout
[include]: https://help.shopify.com/themes/liquid/tags/theme-tags#include
[renderFile]: ../../api/classes/liquid_.liquid.html#renderFile
[renderFileSync]: ../../api/classes/liquid_.liquid.html#renderFilesync
[parseFile]: ../../api/classes/liquid_.liquid.html#parseFile
[parseFileSync]: ../../api/classes/liquid_.liquid.html#parseFileSync
[root]: ../../api/interfaces/liquid_options_.liquidoptions.html#Optional-root
[renderFile]: /api/classes/Liquid.html#renderFile
[renderFileSync]: /api/classes/Liquid.html#renderFileSync
[parseFile]: /api/classes/Liquid.html#parseFile
[parseFileSync]: /api/classes/Liquid.html#parseFileSync
[root]: /api/interfaces/LiquidOptions.html#root
@@ -133,5 +133,5 @@ engine.registerTag('repeat', {
[async]: ./sync-and-async.html
[for]: ../tags/for.html
[if]: ../tags/if.html
[ParseStream]: ../api/classes/parser_parse_stream_.parsestream.html
[ParseStream]: /api/classes/ParseStream.html
[parameter]: ./parse-parameters.html
@@ -108,5 +108,5 @@ engine.registerTag('upper', class UpperTag extends Tag {
})
```
[Liquid]: /api/classes/liquid_.liquid.html
[toPromise]: /api/modules/liquid_.html#toPromise
[Liquid]: /api/classes/Liquid.html
[toPromise]: /api/functions/toPromise.html
@@ -61,12 +61,12 @@ var engine = new Liquid({
`cache` 还可以是一个数字表示最大缓存的模板数量,也可以是一个自定义的缓存实现,详情请参考 [cache 选项][cache]。
[cache]: ../../api/interfaces/liquid_options_.liquidoptions.html#Optional-cache
[cache]: /api/interfaces/LiquidOptions.html#cache
[express-views]: http://expressjs.com/en/guide/using-template-engines.html
[parseFile]: ../../api/classes/liquid_.liquid.html#parseFile
[parseFileSync]: ../../api/classes/liquid_.liquid.html#parseFileSync
[parseFile]: /api/classes/Liquid.html#parseFile
[parseFileSync]: /api/classes/Liquid.html#parseFileSync
[layout]: https://help.shopify.com/en/themes/liquid/tags/theme-tags#layout
[include]: https://help.shopify.com/themes/liquid/tags/theme-tags#include
[root]: ../../api/interfaces/liquid_options_.liquidoptions.html#Optional-root
[root]: /api/interfaces/LiquidOptions.html#root
[render-a-file]: ./render-a-file.html
[Caching]: ./caching.html
@@ -52,5 +52,5 @@ harttle
[shopify/liquid]: https://github.com/Shopify/liquid
[liquidjs]: https://github.com/harttle/liquidjs
[options]: ../../api/interfaces/liquid_options_.liquidoptions.html
[greedy]: ../../api/interfaces/liquid_options_.liquidoptions.html#Optional-greedy
[options]: /api/interfaces/LiquidOptions.html
[greedy]: /api/interfaces/LiquidOptions.html#greedy