遵循格式標準

本頁顯示 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 短代碼，並為新術語新增詞彙表條目。

使用 反引號 表示檔案名稱、目錄和路徑

使用 反引號 表示內嵌程式碼和命令

對於您希望讀者執行的命令，請使用程式碼區塊。僅在提及特定標籤、旗標、值、函式、物件、變數、模組或命令時，才使用行內程式碼和命令。

使用 反引號 表示物件欄位名稱