O3DE文档贡献风格指南

准备好为 Open 3D Engine （O3DE） 文档做出贡献了吗？本风格指南为您提供了提交文档拉取请求的建议和指南。我们尝试为投稿人提供他们需要的有关写作风格、格式和在我们的文档站点中使用的约定的所有信息。如果您需要未包含的指导，向 D&C SIG 提交问题以建议改进。

遵循样式指南是确保对 O3DE 文档的贡献得到快速审查和合并的最佳方式。我们并不期望每个贡献者都了解每一个细节。我们只要求贡献者熟悉本指南并尽其所能地遵循它。拉取请求审查用于捕获贡献中任何最严重的样式错误。

理想性状

O3DE 文档的理想特征是什么？

快速参考 - 常见样式指南规则的快速参考。
编写指南 - 关于我们的文档风格、语气以及如何以易于理解的方式编写的指南。
格式准则 - 有关格式化和排版我们文档的具体规则，例如如何格式化可执行文件名称、文件路径和代码块。涵盖 O3DE 文档网站使用的 Markdown 变体中可用的功能。
格式化工具 - 可以帮助满足某些 O3DE 文档的特殊格式需求的工具列表。
元数据 - 有关在 Markdown 文件的 YAML 标头中使用的可用（和必需）Hugo front matter 元数据的详细信息。
简码 - 我们用于 O3DE 文档的 Hugo 短代码。包括 O3DE 使用的标注框、版本号、静态路径和其他有用的花絮。
提交媒体 - 向文档提交媒体（图像、视频、音频或资产）的指南。

本指南并不是对 Markdown 或 Hugo site generator 的广泛介绍。如果您正在学习 Hugo，请参考使用 Hugo。