docs: add internal types in apidoc (#734)

* docs: add internal types in apidoc * chore: downgrade package-lock version for NodeJS 14 * test: test case when performance uses Date.now
2026-09-20 06:50:47 -07:00 · 2024-08-17 00:55:24 +08:00
parent 4548c11406
commit e941378535
13 changed files with 662 additions and 612 deletions
@@ -19,7 +19,9 @@ pretty_urls:
  trailing_html: false

 theme: navy
-skip_render: "api/**/*"
+skip_render: "api/**"
+ignore: "api/**"
+include: "api/**"
 highlight:
  enable: false
 prismjs:
@@ -3,7 +3,7 @@
  "version": "0.0.0",
  "private": true,
  "hexo": {
-    "version": "5.4.0"
+    "version": "7.3.0"
  },
  "scripts": {
    "build": "hexo generate",
@@ -13,7 +13,7 @@
  },
  "dependencies": {
    "cheerio": "^0.22.0",
-    "hexo": "^5.4.0",
+    "hexo": "^7.3.0",
    "hexo-algolia": "^1.3.1",
    "hexo-clean-css": "^1.0.0",
    "hexo-filter-nofollow": "^2.0.2",
@@ -34,4 +34,4 @@
  "engines": {
    "node": ">=8.10.0"
  }
-}
+}
@@ -7,7 +7,7 @@ const { readFileSync } = require('fs')
 const cheerio = require('cheerio')
 const fullUrlFor = hexo.extend.helper.get('full_url_for').bind(hexo)

-const localizedPath = ['tutorials', 'filters', 'tags', 'playground', 'api']
+const localizedPath = ['tutorials', 'filters', 'tags', 'playground']

 hexo.extend.helper.register('page_nav', function () {
  const type = this.page.canonical_path.split('/')[0]
@@ -128,53 +128,3 @@ tags:
  tablerow: tablerow.html
  unless: unless.html
  when: case.html
-
-api:
-  quick_entry:
-    Liquid: "../classes/liquid_.liquid.html"
-    LiquidOptions: "../interfaces/liquid_options_.liquidoptions.html"
-    FS: "../interfaces/fs_fs_.fs.html"
-    Cache: "../interfaces/cache_cache_.cache.html"
-  classes:
-    BlankDrop: "../classes/drop_blank_drop_.blankdrop.html"
-    Context: "../classes/context_context_.context.html"
-    DelimitedToken: "../classes/tokens_delimited_token_.delimitedtoken.html"
-    Drop: "../classes/drop_drop_.drop.html"
-    EmptyDrop: "../classes/drop_empty_drop_.emptydrop.html"
-    Expression: "../classes/render_expression_.expression.html"
-    FilterToken: "../classes/tokens_filter_token_.filtertoken.html"
-    ForloopDrop: "../classes/drop_forloop_drop_.forloopdrop.html"
-    HTMLToken: "../classes/tokens_html_token_.htmltoken.html"
-    HashToken: "../classes/tokens_hash_token_.hashtoken.html"
-    LRU: "../classes/cache_lru_.lru.html"
-    Liquid: "../classes/liquid_.liquid.html"
-    LiteralToken: "../classes/tokens_literal_token_.literaltoken.html"
-    NullDrop: "../classes/drop_null_drop_.nulldrop.html"
-    NumberToken: "../classes/tokens_number_token_.numbertoken.html"
-    OperatorToken: "../classes/tokens_operator_token_.operatortoken.html"
-    OutputToken: "../classes/tokens_output_token_.outputtoken.html"
-    ParseError: "../classes/util_error_.parseerror.html"
-    ParseStream: "../classes/parser_parse_stream_.parsestream.html"
-    Parser: "../classes/parser_parser_.parser.html"
-    PropertyaccessToken: "../classes/tokens_property_access_token_.propertyaccesstoken.html"
-    QuotedToken: "../classes/tokens_quoted_token_.quotedtoken.html"
-    RangeToken: "../classes/tokens_range_token_.rangetoken.html"
-    Render: "../classes/render_render_.render.html"
-    RenderError: "../classes/util_error_.rendererror.html"
-    TablerowloopDrop: "../classes/drop_tablerowloop_drop_.tablerowloopdrop.html"
-    TagToken: "../classes/tokens_tag_token_.tagtoken.html"
-    Token: "../classes/tokens_token_.token.html"
-    TokenizationError: "../classes/util_error_.tokenizationerror.html"
-    Tokenizer: "../classes/parser_tokenizer_.tokenizer.html"
-    WordToken: "../classes/tokens_word_token_.wordtoken.html"
-  enums:
-    BlockMode: "../enums/context_block_mode_.blockmode.html"
-    TokenKind: "../enums/parser_token_kind_.tokenkind.html"
-  interfaces:
-    Cache: "../interfaces/cache_cache_.cache.html"
-    FilterImplOptions: "../interfaces/template_filter_filter_impl_options_.filterimploptions.html"
-    FS: "../interfaces/fs_fs_.fs.html"
-    LiquidOptions: "../interfaces/liquid_options_.liquidoptions.html"
-    NormalizedFullOptions: "../interfaces/liquid_options_.normalizedfulloptions.html"
-    PlainObject: "../interfaces/context_scope_.plainobject.html"
-    TagImplOptions: "../interfaces/template_tag_tag_impl_options_.tagimploptions.html"
@@ -68,7 +68,7 @@ Here's a demo for browsers: [demo/browser](https://github.com/harttle/liquidjs/t

 ## Abstract File System

-LiquidJS defines an abstract file system interface in [src/fs/fs.ts][ifs] and the default implementation is [src/fs/fs-impl.ts][fs-node] for Node.js and [src/build/fs-impl-browser.ts][fs-browser] for the browser bundle.
+LiquidJS defines an [abstract file system interface][ifs] and the default implementation is [src/fs/fs-impl.ts][fs-node] for Node.js and [src/build/fs-impl-browser.ts][fs-browser] for the browser bundle.

 The `Liquid` constructor provides a [fs][fs] option to specify the file system implementation. It's supposed to be used to define customized template fetching logic, i.e. fetch template from a database table, like:

@@ -74,7 +74,7 @@ var engine = new Liquid({

 ## 文件系统接口

-LiquidJS 定义了一个文件系统接口（[src/fs/ifs.ts][ifs]），在 Node.js 下的默认实现是 [src/fs/node.ts][fs-node]，在浏览器打包文件中的默认实现是 [src/fs/browser.ts][fs-browser]。
+LiquidJS 定义了一个[文件系统接口][ifs]，在 Node.js 下的默认实现是 [src/fs/node.ts][fs-node]，在浏览器打包文件中的默认实现是 [src/fs/browser.ts][fs-browser]。
 你可以通过创建 `Liquid` 时的 [fs][fs] 参数来指定一个自定义实现来指定如何读取模板文件。比如从数据库里读取：

 ```javascript
@@ -62,10 +62,5 @@ sidebar:
    overview: Overview
  tags:
    overview: Overview
-  api:
-    quick_entry: Quick Entry
-    classes: Classes
-    enums: Enums
-    interfaces: Interfaces
 footer:
  license: 'Documentation licensed under <a href="https://creativecommons.org/licenses/by/4.0/" target="_blank">CC BY 4.0</a>.'
@@ -62,11 +62,6 @@ sidebar:
    overview: 概述
  tags:
    overview: 概述
-  api:
-    quick_entry: 快速入口
-    classes: 类
-    enums: 枚举
-    interfaces: 接口

 footer:
  license: '本文档通过 <a href="http://creativecommons.org/licenses/by/4.0/" target="_blank">CC BY 4.0</a> 授权。'