Merge 712e670f9d into 1313415c8b

* feat: add customize flexsearch tokenize feature instruction to docs

* Update configuration.md

* Update configuration.md

* Update configuration.zh-cn.md

---------

Co-authored-by: loenvom <loenvom@qq.com>
Co-authored-by: Xin <xin@imfing.com>

exampleSite/content/docs/guide/configuration.md

@@ -251,6 +251,23 @@ Options for `flexsearch.index`:
 - `heading` - level 1 and level 2 headings
 - `title` - only include the page title
 
+To customize the search tokenize, set the `params.search.flexsearch.tokenize` parameter in the config file:
+
+```yaml {filename="hugo.yaml"}
+params:
+    # ...
+    flexsearch:
+      # full | forward | reverse | strict 
+      tokenize: forward
+```
+
+Options for [`flexsearch.tokenize`](https://github.com/nextapps-de/flexsearch/#tokenizer-prefix-search):
+
+- `strict` - index whole words
+- `forward` - incrementally index words in forward direction
+- `reverse` - incrementally index words in both directions
+- `full` - index every possible combination
+
 To exclude a page from the search index, set the `excludeSearch: true` in the front matter of the page:
 
 ```yaml {filename="content/docs/guide/configuration.md"}

exampleSite/content/docs/guide/configuration.zh-cn.md

@@ -219,6 +219,25 @@ params:
 - `heading` - 一级和二级标题
 - `title` - 仅搜索标题
 
+要自定义检索分词，请在配置文件中设置`params.search.flexsearch.tokenize`：
+
+```hugo.yaml
+params:
+    # ...
+    flexsearch:
+      # full | forward | reverse | strict 
+      tokenize: forward
+```
+
+[`flexsearch.tokenize`](https://github.com/nextapps-de/flexsearch/#tokenizer-prefix-search)的可选项:
+
+- `strict` - 严格单词匹配
+- `forward` - 单词前缀匹配
+- `reverse` - 单词前后缀匹配
+- `full` - 单词子串匹配。
+
+> 在默认的分词逻辑下，中文一句话就是一个“单词”
+
 要从搜索索引中排除页面，更改 front matter 中的 `excludeSearch: true`:
 
 ```yaml {filename="content/docs/guide/configuration.md"}

exampleSite/hugo.yaml

@@ -142,6 +142,7 @@ params:
 
   editURL:
     enable: true
+    location: "toc" # single | toc
     base: "https://github.com/imfing/hextra/edit/main/exampleSite/content"
 
   blog:

layouts/partials/components/edit-url.html

@@ -0,0 +1,28 @@
+{{- $editThisPage := (T "editThisPage") | default "Edit this page"}}
+
+{{- $context := .context -}}
+
+{{- $linkClass := "hx-mb-4 hx-block hx-text-xs hx-text-gray-500 ltr:hx-text-right rtl:hx-text-left dark:hx-text-gray-400" -}}
+
+{{- if and (site.Params.editURL.enable) (eq site.Params.editURL.location .source) -}}
+  {{- $editURL := site.Params.editURL.base | default "" -}}
+
+  {{- with $context.Params.editURL -}}
+    {{/* if `editURL` is set in the front matter */}}
+    {{- $editURL = . -}}
+  {{- else -}}
+    {{- with $context.File -}}
+      {{/* `.FileInfo.Meta.SourceRoot` is a Hugo internal field, e.g. `/path/to/repo/content/en/` */}}
+      {{- $sourceDir := replace (strings.TrimPrefix .FileInfo.Meta.BaseDir .FileInfo.Meta.SourceRoot) "\\" "/" -}}
+      {{- $sourceDir = strings.TrimPrefix "/content" $sourceDir -}}
+      {{- $path := replace .Path "\\" "/" -}}
+      {{- $editURL = urls.JoinPath $editURL $sourceDir $path -}}
+    {{- end -}}
+  {{- end -}}
+
+  {{- if eq site.Params.editURL.location "toc" -}}
+    {{- $linkClass = "hx-text-xs hx-font-medium hx-text-gray-500 hover:hx-text-gray-900 dark:hx-text-gray-400 dark:hover:hx-text-gray-100 contrast-more:hx-text-gray-800 contrast-more:dark:hx-text-gray-50" -}}
+  {{- end -}}
+
+  <a class="{{ $linkClass }}" href="{{ $editURL }}" target="_blank" rel="noreferer">{{ $editThisPage }}</a>
+{{- end -}}

layouts/partials/components/last-updated.html

@@ -1,9 +1,12 @@
 {{- $lastUpdated := (T "lastUpdated") | default "Last updated on" -}}
 
 {{- if site.Params.displayUpdatedDate -}}
+<div class="hx-mt-12 hx-mb-8 hx-block hx-text-xs hx-text-gray-500 ltr:hx-text-right rtl:hx-text-left dark:hx-text-gray-400">
+{{ partial "components/edit-url.html" (dict "source" "single" "context" .) }}
   {{- with .Lastmod -}}
     {{ $datetime := (time.Format "2006-01-02T15:04:05.000Z" .) }}
-    <div class="hx-mt-12 hx-mb-8 hx-block hx-text-xs hx-text-gray-500 ltr:hx-text-right rtl:hx-text-left dark:hx-text-gray-400">{{ $lastUpdated }} <time datetime="{{ $datetime }}">{{ partial "utils/format-date" . }}</time></div>
+    <div class="hx-mt-4">{{ $lastUpdated }} <time datetime="{{ $datetime }}">{{ partial "utils/format-date" . }}</time></div>
+  </div>
   {{- else -}}
     <div class="hx-mt-16"></div>
   {{- end -}}

layouts/partials/toc.html

@@ -24,22 +24,7 @@
 
       {{/* TOC bottom part */}}
       <div class="{{ $borderClass }} hx-sticky hx-bottom-0 hx-flex hx-flex-col hx-items-start hx-gap-2 hx-pb-8 dark:hx-border-neutral-800 contrast-more:hx-border-t contrast-more:hx-border-neutral-400 contrast-more:hx-shadow-none contrast-more:dark:hx-border-neutral-400">
-        {{- if site.Params.editURL.enable -}}
-          {{- $editURL := site.Params.editURL.base | default "" -}}
-          {{- with .Params.editURL -}}
-            {{/* if `editURL` is set in the front matter */}}
-            {{- $editURL = . -}}
-          {{- else -}}
-            {{- with .File -}}
-              {{/* `.FileInfo.Meta.SourceRoot` is a Hugo internal field, e.g. `/path/to/repo/content/en/` */}}
-              {{- $sourceDir := replace (strings.TrimPrefix .FileInfo.Meta.BaseDir .FileInfo.Meta.SourceRoot) "\\" "/" -}}
-              {{- $sourceDir = strings.TrimPrefix "/content" $sourceDir -}}
-              {{- $path := replace .Path "\\" "/" -}}
-              {{- $editURL = urls.JoinPath $editURL $sourceDir $path -}}
-            {{- end -}}
-          {{- end -}}
-          <a class="hx-text-xs hx-font-medium hx-text-gray-500 hover:hx-text-gray-900 dark:hx-text-gray-400 dark:hover:hx-text-gray-100 contrast-more:hx-text-gray-800 contrast-more:dark:hx-text-gray-50" href="{{ $editURL }}" target="_blank" rel="noreferer">{{ $editThisPage }}</a>
-        {{- end -}}
+      {{ partial "components/edit-url.html" (dict "source" "toc" "context" .) }}
         {{/* Scroll To Top */}}
         <button aria-hidden="true" id="backToTop" onClick="scrollUp();" class="hx-transition-all hx-duration-75 hx-opacity-0 hx-text-xs hx-font-medium hx-text-gray-500 hover:hx-text-gray-900 dark:hx-text-gray-400 dark:hover:hx-text-gray-100 contrast-more:hx-text-gray-800 contrast-more:dark:hx-text-gray-50">
           <span>