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

风格指南

最后更新 查看 MarkdownAgent 设置

无论内容位于文档还是产品仪表板中,编写或审阅 Cloudflare 内容时都请使用本指南。遵循它,才能让整个站点读起来像每一页都出自同一位细心作者,同时也让内容对读者更清晰、更易于翻译。

本指南按您实际工作的方式组织,分为五个阶段:贡献变更、规划内容、按 Cloudflare 风格撰写、构建页面,以及(面向 Cloudflare 团队)运行站点。

贡献

从这里开始。做出变更并把它合并进去。

贡献

提交 issue 或提出 pull request,然后跟进到审阅合并。

规划内容

决定您要写哪种页面,以及它放在哪里。

内容策略

选择内容类型,组织页面结构,并将其放入信息架构。

API 内容

遵循记录端点、参数和资源的约定。

风格与语法

用统一文风、语法和格式来写页面。

语法

应用词性、标点和大小写规则。

格式

一致地格式化日期、数字、代码、列表、表格和 UI 元素。

构建页面

用 MDX 编写页面,设置其元数据,并添加组件。

Markdown 与 MDX

了解 MDX 语法、如何导入组件,以及如何转义特殊字符。

Frontmatter

声明每个页面携带的必需和可选元数据。

组件

用添加按钮、选项卡等内容的 MDX 组件来组装页面。

我们如何编写文档

Cloudflare 团队如何运行该站点。本节是 Cloudflare 特有的内部流程。

这篇文档对您有帮助吗?