Compare commits

...

6 Commits

Author SHA1 Message Date
0d896b7e23 Merge ff565f2077 into 1313415c8b 2024-06-28 12:45:05 +00:00
ff565f2077 Remove markdown syntax highlight 2024-06-28 15:45:00 +03:00
33dbd4561c Escape PDF shortcode examples 2024-06-28 15:39:34 +03:00
2355432542 Update pdf.md 2024-06-28 15:36:43 +03:00
24a2734ee5 Create pdf.md 2024-06-28 14:40:22 +03:00
1313415c8b feat: add customize flexsearch tokenize feature instruction to docs (#322)
* 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>
2024-06-02 13:53:38 +01:00
3 changed files with 53 additions and 0 deletions

View File

@ -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"}

View File

@ -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"}

View File

@ -0,0 +1,17 @@
---
title: Pdf
---
## Example
{{< pdf "https://dagrs.berkeley.edu/sites/default/files/2020-01/sample.pdf" >}}
## Usage
### With URL
```
{{</* pdf "https://dagrs.berkeley.edu/sites/default/files/2020-01/sample.pdf" */>}}
```
### With Path
```
{{</* pdf "path/to/your/pdf/file.pdf" */>}}
```