参考内容的目的是提供补充信息,以便进一步了解设置、值或选项。虽然参考信息对用户很有帮助,但参考信息不应阻碍或阻止用户完成任务。
平实、直截了当
pcx_content_type: reference
products:
- product-a
- product-b
- product-c有关更多详细信息,请参阅 pcx_content_type。
标题:对于单个“参考”页面,使用“参考”作为标题。对于包含子页面的参考板块,标题中要使用名词。例如,常见 Cf-Polished 状态。
上下文:提供一个介绍性段落,解释用户可以如何以及为什么要利用该页面上的信息。
代码段:API 响应或运行特定任务的命令的示例。
动态列表:较长的字段列表(超过 20 个)。
示例:引用特定配置或 API 调用的代码示例。
注释/提示/警告:可帮助简化概念或警告用户潜在影响的相关信息。
屏幕截图:针对复杂任务的已完成配置的图像。
表格:关于功能和关联数值或术语及其定义的较长列表。
Cache: Common Cf-Polished statuses
Logpush: Logpush API configuration
单个参考页面
---
weight: xx
pcx_content_type: reference
description: <Cloudflare 产品或功能> 的参考信息,包括 <涵盖的关键设置、值或选项>。
products:
- product-a
- product-b
- product-c
---
# 参考
编写本页面上参考信息的概览。如果该板块有子页面,请在下方使用 DirectoryListing 片段添加导航链接,以无序列表的形式添加每个子页面的链接。
<DirectoryListing path="/reference"/>
## 简明名词标题
此板块中内容的简短描述。
## 简明名词标题
此板块中内容的简短描述。