在站点中隐藏内容

Fern 为您提供了两个主要工具来控制内容可见性：在 docs.yml 中设置 hidden: true 可以从站点侧边栏和搜索结果中移除内容，而在页面前言中设置 noindex: true 可以在不影响导航的情况下将页面从搜索中排除。

隐藏页面

仅通过直接 URL 访问

在 docs.yml 中设置 hidden: true 可以从侧边栏、搜索结果和 llms.txt 中移除页面，同时保持通过直接链接访问。这对于与审核人员分享草稿文档或从外部工具（如支持工单）进行链接很有用。无需同时设置 noindex — hidden: true 会自动处理两者。

1
navigation:
2
  - section: Introduction
3
    contents:
4
      - page: My Page
5
        path: ./pages/my-page.mdx
6
      - page: Hide and Seek
7
        hidden: true
8
        path: ./pages/hide-and-seek.mdx
9
  - api: API Reference

仅从搜索中排除

在页面前言中设置 noindex: true 可以将其从搜索引擎和 llms.txt 中排除，同时保持在站点上的可发现性。这对于早期访问文档或您希望读者通过导航而非搜索或 AI 工具找到的内容很有用。

1
---
2
title: Early access feature
3
noindex: true
4
---

有关更多 SEO 相关选项，请参见 SEO 元数据。

隐藏 API 端点

在 docs.yml 中的端点布局配置中设置 hidden: true 可以将其从侧边栏中隐藏。与页面级别的 hidden 一样，隐藏的端点会自动从搜索引擎索引中排除，因此无需设置 noindex: true。

1
navigation:
2
  - api: API Reference
3
    layout:
4
      - plants:
5
          - endpoint: POST /plants/{plantId}
6
            hidden: true

有关完整配置详情，包括 OpenAPI、Fern Definition 和 WebSocket 端点的示例，请参见隐藏端点。

隐藏章节、选项卡、选项卡变体或版本

从导航中隐藏整个章节、选项卡、选项卡变体或版本 — 例如，旧版 API、内部选项卡或内部工具文档章节。

与隐藏页面或端点不同，隐藏章节、选项卡、选项卡变体或版本只会从导航中移除组。其中的单个页面仍然会被搜索引擎和 AI 索引，因为 hidden 应用于组，而不是每个页面。要同时从搜索结果中排除单个页面，请在每个页面的前言中添加 noindex: true。

章节

选项卡

选项卡变体

版本

docs.yml

1
navigation:
2
  - section: Introduction
3
    contents:
4
      - page: My Page
5
        path: ./pages/my-page.mdx
6
  - api: API Reference
7
  - section: Hidden Section
8
    hidden: true
9
    contents:
10
      - page: Hide and Seek
11
        path: ./pages/hide-and-seek.mdx