mirror of
https://github.com/mintlify/docs.git
synced 2026-09-14 13:35:46 +08:00
mintlify[bot]
3bebd828f6
* docs: sync es/fr/zh translations with recent English updates * docs: tighten translated SEO metadata and fix register consistency --------- Co-authored-by: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com>
152 lines
6.2 KiB
Plaintext
152 lines
6.2 KiB
Plaintext
---
|
||
title: "配置站内搜索的排名、结果和筛选器"
|
||
sidebarTitle: "搜索"
|
||
description: "配置你的 Mintlify 文档站点上的站内搜索栏：排名加权、每次查询的最大结果数，以及按产品和版本进行的搜索筛选器。"
|
||
keywords: ["搜索", "搜索排名", "搜索加权", "加权", "搜索优先级", "最大搜索结果数", "最大结果数", "searchable", "从搜索中排除", "筛选器"]
|
||
---
|
||
|
||
配置你 Mintlify 托管的文档站点上的搜索栏的行为。这些设置仅影响站内搜索。它们不会改变外部搜索引擎对你页面的索引方式。
|
||
|
||
<div id="boost-search-ranking">
|
||
## 提升搜索排名
|
||
</div>
|
||
|
||
使用 `boost` 让特定页面或章节在站内搜索中获得更高的排名权重。该值是一个应用于每个内容片段相关性得分的数值乘数：`boost: 3` 会使某个片段的相关性提升为没有加权时的三倍。
|
||
|
||
<div id="boost-a-single-page">
|
||
### 为单个页面加权
|
||
</div>
|
||
|
||
在页面的 [frontmatter](/zh/organize/pages) 中设置 `boost`，可放大其搜索排名。
|
||
|
||
```mdx
|
||
---
|
||
title: "Custom domain"
|
||
description: "Connect your custom domain to your Mintlify documentation."
|
||
boost: 3
|
||
---
|
||
```
|
||
|
||
<div id="boost-a-navigation-group">
|
||
### 为导航分组加权
|
||
</div>
|
||
|
||
在 `docs.json` 导航中的某个分组上设置 `boost`，可将该乘数应用于其下的每个页面。
|
||
|
||
```json
|
||
{
|
||
"navigation": {
|
||
"groups": [
|
||
{
|
||
"group": "Get started",
|
||
"boost": 5,
|
||
"pages": [
|
||
"quickstart",
|
||
"concepts"
|
||
]
|
||
}
|
||
]
|
||
}
|
||
}
|
||
```
|
||
|
||
页面会从最近一个设置了加权值的祖先那里继承加权因子。子页面或嵌套分组可以通过设置自己的 `boost` 值来覆盖继承的加权。页面 frontmatter 中的 `boost` 始终优先于从导航继承的值。
|
||
|
||
<div id="de-prioritize-content">
|
||
### 降低内容优先级
|
||
</div>
|
||
|
||
使用小于 `1` 的值可将页面在搜索结果中下推。例如，`boost: 0.5` 会将页面的相关性得分相对于其他页面减半。`boost` 为 `1` 时等同于不加权。
|
||
|
||
```mdx
|
||
---
|
||
title: "Deprecated API"
|
||
description: "Documentation for the deprecated v1 API."
|
||
boost: 0.25
|
||
---
|
||
```
|
||
|
||
<Note>
|
||
加权因子会与已有的相关性得分相乘。请谨慎使用。过大的乘数会导致相关性较低的页面在搜索结果中占据主导地位，从而降低整体搜索质量。
|
||
</Note>
|
||
|
||
<div id="recommended-boost-range">
|
||
### 推荐的 boost 取值范围
|
||
</div>
|
||
|
||
`boost` 接受任意正数。在实际使用中，请将其保持在 `0.1` 到 `10` 之间：
|
||
|
||
- `0.1`–`0.9`：降低旧版、已废弃或辅助性内容的优先级。
|
||
- `1`：不做任何改变 (等同于省略 `boost`)。
|
||
- `2`–`5`：优先展示关键落地页、快速入门或访问量较大的参考页面。
|
||
- `5`–`10`：仅保留给少数几个几乎总应排在最前面的顶层页面。
|
||
|
||
避免使用大于 `10` 的值。过大的乘数会压过底层的相关性得分，导致即便与查询匹配程度不高，加权页面也会被推到前面。
|
||
|
||
<div id="exclude-a-page-from-search">
|
||
## 将页面从搜索中排除
|
||
</div>
|
||
|
||
默认情况下，页面是可搜索的。`searchable` 字段为可选项，默认值为 `true`。在页面的 [frontmatter](/zh/organize/pages) 中设置 `searchable: false`，可将该页面从文档站点的搜索结果中排除。`searchable` 仅是页面级字段——若要排除某个导航标签页或分组下的所有页面，请改为隐藏该标签页或分组。有关标签页和分组级别的控制方式，请参阅[隐藏页面](/zh/organize/hidden-pages)。
|
||
|
||
```mdx
|
||
---
|
||
title: "内部备注"
|
||
description: "不希望出现在搜索结果中的参考资料。"
|
||
searchable: false
|
||
---
|
||
```
|
||
|
||
与 `noindex` 不同，`searchable: false` 不影响外部 SEO。该页面仍然：
|
||
|
||
- 可被外部搜索引擎抓取
|
||
- 列在你的 `sitemap.xml` 中
|
||
|
||
它会从文档站点的搜索结果和 AI 助手 context 中被排除。
|
||
|
||
将 `searchable: false` 用于那些应通过直接链接或外部搜索引擎保持可访问，但不应在用户在你的文档中搜索时出现的页面，例如，深度参考页面、遗留内容，或会挤占更相关结果的辅助资料。
|
||
|
||
要将页面同时从站点搜索和外部索引中排除，请改用 [`noindex: true`](/zh/optimize/seo#disable-indexing)。
|
||
|
||
<div id="maximum-search-results">
|
||
## 最大搜索结果数
|
||
</div>
|
||
|
||
通过控制台控制搜索栏每次查询返回的结果数量。默认值为 `6` 个结果。你可以设置 `1` 到 `100` 之间的任意值。
|
||
|
||
在控制台中前往 [Search](https://app.mintlify.com/settings/deployment/search) 设置页面。在 "Maximum search results" 部分，将 **Results per query** 设置为你想要的值。
|
||
|
||
<Frame>
|
||
<img
|
||
alt="控制台中的搜索设置页面，Maximum search results 步进器设为 6。"
|
||
className="block dark:hidden"
|
||
src="/images/search-settings-light.png"
|
||
/>
|
||
<img
|
||
alt="控制台中的搜索设置页面，Maximum search results 步进器设为 6。"
|
||
className="hidden dark:block"
|
||
src="/images/search-settings-dark.png"
|
||
/>
|
||
</Frame>
|
||
|
||
较高的值会在每次查询中呈现更多匹配，这对覆盖主题广泛、用户期望浏览许多候选项的站点很有用。较低的值会让结果面板保持紧凑，并促使用户关注排名最高的匹配项。
|
||
|
||
<div id="search-filters">
|
||
## 搜索筛选器
|
||
</div>
|
||
|
||
<Note>
|
||
搜索筛选器需要 [Enterprise 套餐](https://mintlify.com/pricing?ref=search-filters)。
|
||
</Note>
|
||
|
||
搜索筛选器会在搜索结果中添加产品和版本下拉菜单，以便用户将结果限定到单个产品或版本。对于维护多个不同产品或版本的站点，筛选器很有用，否则搜索查询可能会返回用户并不关心的内容匹配。
|
||
|
||
在控制台的 [Search](https://app.mintlify.com/settings/deployment/search) 设置页面启用或禁用搜索筛选器。
|
||
|
||
显示哪些下拉菜单取决于你的导航配置。
|
||
|
||
- 当你的导航定义了多个[产品](/zh/organize/navigation#products)时，会出现**产品**筛选器。
|
||
- 当你的导航定义了[版本](/zh/organize/navigation#versions)时，会出现**版本**筛选器。
|
||
|
||
如果你的导航既没有产品也没有版本，启用搜索筛选器不会产生任何可见效果。
|