For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
预约演示登录免费开始
  • 入门
    • 概览
    • 工作原理
    • 快速开始
    • 项目结构
    • Customer showcase
    • 变更日志
  • 配置
    • 概览
    • 站点级设置
    • 页面级设置
  • 编写内容
    • Markdown 基础
    • Markdown 中的富媒体
    • Fern 编辑器
    • 可复用代码片段
  • AI 功能
    • 概览
    • Fern Writer
    • AI 生成的示例
    • Markdown 访问
      • 概览
      • Agent 指令
      • 智能体指令
      • 分析与集成
    • MCP 服务器
    • API 目录发现
      • 概览
      • 嵌入模式
      • Hiding content
      • Search
      • 收集用户反馈和建议
      • 完全自定义文档
      • CSS 选择器参考
      • 自定义 React 组件
      • 页眉和页脚
      • 全局主题
  • Public API
    • GETJWT from Fern API key
    • GETAlgolia search credentials
    • GETCurrent user information
  • Fern Writer API
    • GETGet Fern Writer Install Link
Checking status...
SOC2Soc 2 Type II
© 2026 Fern • Birch Solutions, Inc., a Postman company

Documentation

SDKsDocsAsk FernCLI Reference

API Definitions

OpenAPIAsyncAPIOpenRPCgRPC

Resources

BlogSupportPricing

Company

Brand KitPrivacy PolicyTerms of Service
LogoLogo
预约演示登录免费开始
在本页
  • 隐藏页面
  • 仅通过直接URL访问
  • 仅从搜索中排除
  • 隐藏API端点
  • 隐藏部分、选项卡、选项卡变体或版本
配置

在您的网站中隐藏内容

||以 Markdown 格式查看|
此页面是否有帮助?
在仪表板中编辑
上一个

嵌入模式

下一个

搜索配置

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

隐藏页面

仅通过直接URL访问

在 docs.yml 中设置 hidden: true 可以从侧边栏、搜索结果和 llms.txt 中移除页面,但仍可通过直接链接访问。这对于与审阅者分享草稿文档或从支持工单等外部工具链接很有用。无需同时设置 noindex — hidden: true 会自动处理这两种情况。

docs.yml
1navigation:
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工具找到的内容很有用。

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

有关更多SEO相关选项,请参阅 SEO元数据。

隐藏API端点

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

docs.yml
1navigation:
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
1navigation:
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
带有隐藏部分的网站