Skip to content

docs: document per-deployment maximum search results setting (zh) #5943

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
mintlify-development wants to merge 1 commit into from
+35 −8
Closed

docs: document per-deployment maximum search results setting (zh) #5943

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
43 changes: 35 additions & 8 deletions zh/optimize/search-boost.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,15 +1,19 @@
---
title: "搜索加权"
description: "通过在页面 frontmatter 或 `docs.json` 导航中设置数值加权乘数，使你的文档站点内置搜索的排名向特定页面或章节倾斜。"
keywords: ["搜索排名", "搜索加权", "加权", "搜索优先级"]
title: "搜索"
description: "配置 Mintlify 文档站点内置搜索栏的行为，包括排名加权和每次查询返回的结果数量。"
keywords: ["搜索", "搜索排名", "搜索加权", "加权", "搜索优先级", "最大搜索结果数", "最大结果数"]
---

使用 `boost` 让特定页面或章节在站内搜索中获得更高的排名权重。该值是一个应用于每个内容片段相关性得分的数值乘数：`boost: 3` 会使某个片段的相关性提升为没有加权时的三倍。
配置 Mintlify 托管的文档站点上搜索栏的行为。这些设置只影响站内搜索，不会改变外部搜索引擎对你页面的索引方式。

`boost` 仅影响 Mintlify 托管的文档站点上的搜索栏。它不会改变外部搜索引擎对你页面的索引方式。
<div id="boost-search-ranking">
## 提升搜索排名
</div>

使用 `boost` 让特定页面或章节在站内搜索中获得更高的排名权重。该值是一个应用于每个内容片段相关性得分的数值乘数：`boost: 3` 会使某个片段的相关性提升为没有加权时的三倍。

<div id="boost-a-single-page">
## 为单个页面加权
### 为单个页面加权
</div>

在页面的 [frontmatter](/zh/organize/pages) 中设置 `boost`，可放大其搜索排名。
Expand All @@ -23,7 +27,7 @@ boost: 3
```

<div id="boost-a-navigation-group">
## 为导航分组加权
### 为导航分组加权
</div>

在 `docs.json` 导航中的某个分组上设置 `boost`，可将该乘数应用于其下的每个页面。
Expand All @@ -48,7 +52,7 @@ boost: 3
页面会从最近一个设置了加权值的祖先那里继承加权因子。子页面或嵌套分组可以通过设置自己的 `boost` 值来覆盖继承的加权。页面 frontmatter 中的 `boost` 始终优先于从导航继承的值。

<div id="de-prioritize-content">
## 降低内容优先级
### 降低内容优先级
</div>

使用小于 `1` 的值可将页面在搜索结果中下推。例如，`boost: 0.5` 会将页面的相关性得分相对于其他页面减半。`boost` 为 `1` 时等同于不加权。
Expand All @@ -64,3 +68,26 @@ boost: 0.25
<Note>
加权因子会与已有的相关性得分相乘。请谨慎使用。过大的乘数会导致相关性较低的页面在搜索结果中占据主导地位，从而降低整体搜索质量。
</Note>

<div id="maximum-search-results">
## 最大搜索结果数
</div>

在仪表盘中控制搜索栏每次查询返回的结果数量。默认值为 `6` 个结果。你可以设置 `1` 到 `100` 之间的任意值。

在你的仪表盘中，依次进入 **Settings** > **Deployment** > **Search**，将 **Maximum search results** 设置为你想要的值，然后选择 **Save changes**。

<Frame>
<img
alt="仪表盘中的 Search 设置页面，Maximum search results 步进器设置为 6。"
className="block dark:hidden"
src="/images/search-settings-light.png"
/>
<img
alt="仪表盘中的 Search 设置页面，Maximum search results 步进器设置为 6。"
className="hidden dark:block"
src="/images/search-settings-dark.png"
/>
</Frame>

较高的值会在每次查询中显示更多匹配项，适用于主题覆盖范围较广、用户希望浏览多个候选结果的站点。较低的值可以保持结果面板紧凑，并引导用户关注排名最高的匹配项。
Loading