遵循格式标准

此页面显示了 Istio 文档的格式标准。Istio 使用 Markdown 来标记内容，并使用 Hugo 来构建网站。为了确保我们文档的一致性，我们已商定了这些格式标准。

不要使用大写字母来强调

仅当直接引用这些值时，才使用在代码或配置文件中找到的原始大写字母。使用反引号 `` 围绕引用的值以明确表示连接。例如，使用 `IstioRoleBinding`，而不是 `Istio Role Binding` 或 `istio role binding`。

如果你没有直接引用值或代码，请使用正常的句子大写字母，例如，“Istio 角色绑定配置在 YAML 文件中进行”。

使用尖括号作为占位符

在命令或代码示例中，使用尖括号作为占位符。告诉读者占位符代表什么。例如

1. Display information about a pod:

    {{< text bash >}}
    $ kubectl describe pod <pod-name>
    {{< /text >}}

    Where `<pod-name>` is the name of one of your pods.

使用 **粗体** 来强调用户界面元素

使用 *斜体* 来强调新词

使用 `gloss` 短代码，并为新词添加词汇表条目。

使用 `反引号` 围绕文件名、目录和路径

使用 `反引号` 围绕内联代码和命令

对于您希望读者执行的命令，请使用代码块。仅使用内联代码和命令来提及特定的标签、标志、值、函数、对象、变量、模块或命令。

使用 `反引号` 围绕对象字段名