在您的网站中隐藏内容

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和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