Skip to main content
相关页面会在每个文档页面底部呈现一个 相关主题 部分，帮助读者发现相互关联的内容。推荐来源可以是基于搜索的自动建议，也可以是你在页面 frontmatter 中整理的链接，或两者的组合。 相关页面是一项部署 add-on。请在你的仪表盘中启用它：
  1. 打开仪表盘并进入 设置 > Add-ons。
  2. 找到 相关主题 并将其开启。
  3. 选择一种模式，并根据需要设置显示页面数量的上限。

​
模式

​
mode
基于当前页面的标题，从你文档的搜索索引中生成推荐。当页面中设置了 frontmatter 覆盖时，仍以 frontmatter 为准。当你希望相关页面在新增内容时自动更新时，请使用此模式。
​
mode
仅显示页面 related frontmatter 中列出的页面。没有 related 字段的页面不会显示 相关主题 部分。当你希望完全掌控编辑内容时，请使用此模式。

​
数量上限

设置要显示的相关页面数量。默认值为 5，最大值为 10。该上限适用于自动推荐；手动条目也以最大值为上限。

​
通过 frontmatter 按页配置

使用 related frontmatter 字段可以覆盖或直接为某个页面提供相关页面列表。此字段在 Automatic 和 Manual 两种模式下均可使用。
​
array | false
相关页面列表，或设为 false 以隐藏该页面的 相关主题 部分。每个条目可以是：
  • 指向文档中另一个页面的根相对路径：/api-playground/overview
  • 指向外部站点的绝对 URL：https://example.com/docs
  • 用于设置显式标签的 Title: link 对象
当未显式设置时，内部路径的标题和图标会从你的导航中推断得到。外部链接会在新标签页中打开。

​
示例

整理一组内部页面：
混合使用内部页面、外部链接和自定义标题：
在特定页面上隐藏 相关主题 部分：

​
推荐是如何生成的

在 Automatic 模式下，相关页面基于你文档的搜索索引，将当前页面的标题作为查询条件生成。结果会按照页面的语言和版本（如适用）进行过滤，且会排除当前页面。 对于启用了终端用户认证的部署，自动推荐会被禁用，以避免跨用户上下文泄露内容。在启用了用户认证的部署上，请使用 related frontmatter 字段来展示经过整理的推荐。

​
当推荐未显示时

如果在 Automatic 模式下,某个页面的 相关主题 部分为空:
  • 搜索索引可能尚未就绪。自动推荐会在每次部署后重建,因此请在发布新内容后等待几分钟再重新加载页面。
  • 你的文档中可能没有足够多的相似内容供 Mintlify 推荐。自动推荐仅从同一页面的语言和版本中抽取,因此文档规模较小或某个语言环境内容较少时,可能返回不到匹配结果。
  • 已启用终端用户认证。请改用 related frontmatter 字段来整理推荐。
  • 页面使用了 related: false,该部分被有意隐藏。
  • 页面：使用 frontmatter 配置页面元数据。
  • 链接：连接页面的最佳实践。
  • 搜索：配置搜索结果的排序和过滤方式。