docs: document the search.indexPreload parameter

razonyang · May 6, 2023 · ae5fabb · ae5fabb
1 parent ece5f95
commit ae5fabb
Show file tree

Hide file tree

Showing 3 changed files with 3 additions and 0 deletions.
diff --git a/exampleSite/content/docs/layouts/search/index.md b/exampleSite/content/docs/layouts/search/index.md
@@ -48,6 +48,7 @@ title = "Search"
 | `search` | Object | - | Search configuration.
 | `search.paginate` | Integer | `10` | Pagination.
 | `search.indexPaginate` | Integer | `1000` | Index file pagination.
+| `search.indexPreload` | Boolean | `true` | Whether to preload the search indices.
 | `search.maxResults` | Number | `100` | The max number of search results.
 | `search.resultContentCharactersCount` | Integer | `240` | The maximum characters count of result content for displaying.
 | `search.shortcut` | Array | `["/"]` | The search shortcut, i.e. `["Control", "/"]`, disable it by a empty array `[]`.

diff --git a/exampleSite/content/docs/layouts/search/index.zh-hans.md b/exampleSite/content/docs/layouts/search/index.zh-hans.md
@@ -48,6 +48,7 @@ title = "Search"
 | `search` | Object | - | 搜索配置。
 | `search.paginate` | Integer | `10` | 分页。
 | `search.indexPaginate` | Integer | `1000` | Index file pagination.
+| `search.indexPreload` | Boolean | `true` | 是否预加载搜索索引。
 | `search.maxResults` | Number | `100` | 至多返回的搜索结果数目。
 | `search.shortcut` | Array | `["/"]` | 搜索快捷键，比如 `["Control", "/"]`，空数组 `[]` 则禁用。
 | `search.resultContentCharactersCount` | Integer | `240` | 搜索结果内容最大字符数。

diff --git a/exampleSite/content/docs/layouts/search/index.zh-hant.md b/exampleSite/content/docs/layouts/search/index.zh-hant.md
@@ -48,6 +48,7 @@ title = "Search"
 | `search` | Object | - | 搜尋配置。
 | `search.paginate` | Integer | `10` | 分頁。
 | `search.indexPaginate` | Integer | `1000` | Index file pagination.
+| `search.indexPreload` | Boolean | `true` | 是否預加載搜索索引。
 | `search.maxResults` | Number | `100` | 至多返回的搜索結果數目。
 | `search.shortcut` | Array | `["/"]` | 搜索快捷鍵，比如 `["Control", "/"]`，空數組 `[]` 則禁用。
 | `search.resultContentCharactersCount` | Integer | `240` | 搜尋結果內容最大字符數。