跳转到内容
本站为社区维护的非官方中文翻译,与 Cloudflare, Inc. 无关联。本站不提供账户登录,请勿在任何非官方站点输入您的 Cloudflare 账户信息。官方文档:developers.cloudflare.com

导航

最后更新 查看 MarkdownAgent 设置

导航页面是子落地页,将读者引导到文档的特定区域。它几乎没有自己的正文:一段简短介绍,加上自动生成的子页面列表。语气应简短、实用。

何时使用

当文档某个区域的子页面足够多,读者需要一个带路标的入口进入这些页面时,编写导航页面。它不是:

  • 概览。 概览介绍产品,并用正文帮助新读者定位;导航页面主要为其下的子页面提供路标。
  • 概念。 概念解释某事物如何运作;导航页面不作解释,只把读者继续往下引导。

完整对比请参阅内容类型。

标题与描述

  • 标题:为该页面所代表的板块或区域命名,并与读者点击进入时看到的标题一致。
  • 描述:邀请读者探索该区域,并点明子页面涵盖的关键主题。

搭建此页面

复制此骨架并根据您的区域进行调整:

---
title: <Section or area name>
description: Explore <area>, covering <the key topics the child pages cover>.
pcx_content_type: navigation
sidebar:
  order: 10
products:
  - product-a
---

import { DirectoryListing } from "~/components";

Introduce the area in one or two sentences, then let the listing route the reader to the child pages.

<DirectoryListing />

组件指南

  • DirectoryListing 承担页面正文:它把文件夹的子页面显示为链接列表,并自动生成,以便页面增删时列表保持最新。
  • 不适合放在这里的内容: 实质性解释或操作步骤。导航页面本身不承载内容,请把解释放在它所链接的页面上。

Frontmatter

pcx_content_type: navigation
products:
  - product-a
  - product-b

有关更多详细信息,请参阅 pcx_content_type。

示例

面向 AI 与智能体撰写

  • 自动列表。 使用 DirectoryListing 而不是手写列表,这样智能体所跟随的路由始终是当前的子页面。
  • 不要留下孤立内容。 不要把解释和操作步骤放在导航页上,因为落在此处的智能体应被继续引导,而不是被要求阅读正文。
  • 子页面标题要能独立理解。 列表展示的是每个子页面的标题,因此这些标题必须能单独成立,因为这是读者或智能体选择去向时的唯一信号。

这篇文档对您有帮助吗?