跳转到主要内容
使用 Visibility 组件在同一页面上向不同受众显示不同的内容。你可以针对浏览你网站的人类读者、处理 Markdown 输出的 AI 代理,或根据读者的登录状态和用户组进行展示。这让你可以为不同受众定制信息,无需维护多个独立页面。 在你已发布的网站上,标记为 for="humans" 的内容会正常渲染,而标记为 for="agents" 的内容则被隐藏。在 Markdown 页面视图(.md URL)中则相反——代理内容会在 Markdown 输出中渲染,而仅供人类阅读的内容不会。同样的规则也适用于 llms-full.txt 文件。

示例

你正在网页上查看此内容。此内容在你网站的标准页面上正常显示。可用于如下步骤:点击右上角的 Get started 按钮来创建你的账户。在此示例中,面向界面的说明显示在标准页面上。查看此页面的 Markdown 版本以查看面向代理的 API 说明。

按登录状态或分组显示内容

如果你的网站使用了身份验证,你可以根据读者是否已登录或其所属的分组来显示内容。
  • signed-in 内容仅对拥有活动会话的读者渲染。
  • signed-out 内容仅对未登录的读者渲染。
  • groups 内容仅对至少属于所列分组之一的已登录读者渲染。
Markdown 页面视图和 llms-full.txt 对每位读者都是相同的,因此代理始终获得未登录视图。Mintlify 会从 Markdown 输出中移除 signed-in 和 groups 内容,并包含 signed-out 内容。 要在本地检查这些规则,请运行 mint dev --signed-in 或 mint dev --groups。如果两个选项都未使用,本地预览将显示未登录视图。
登录和分组规则仅在浏览器中隐藏内容。Mintlify 仍会将被隐藏的内容发送到每位读者的浏览器。要限制对敏感内容的访问,请将其放在单独的页面上,并使用 groups frontmatter 属性。

属性

string | object
必填
包裹内容的目标受众。必须为以下之一:
  • humans:在网页上可见,从 Markdown 输出中排除。
  • agents:在网页上隐藏,包含在 Markdown 输出中。
  • signed-in:在网页上对已登录读者可见,从 Markdown 输出中排除。
  • signed-out:在网页上对未登录读者可见,包含在 Markdown 输出中。
  • { groups: [...] }:在网页上对至少属于所列分组之一的已登录读者可见,从 Markdown 输出中排除。
请使用静态值。Mintlify 会从 Markdown 输出中排除 for 值为计算结果(例如变量或条件表达式)的内容。