前言
前言是每個檔案頂部以三條破折號分隔的 YAML 程式碼,並為我們的內容提供重要的管理選項。例如,前言允許我們確保現有的連結繼續適用於移動或完全刪除的頁面。此頁面說明目前在 Istio 中可用的前言功能。
以下範例顯示一個前言,其中所有必要欄位都由預留位置填寫
---
title: <title>
description: <description>
weight: <weight>
keywords: [<keyword1>,<keyword2>,...]
aliases:
- <previously-published-at-this-URL>
---
您可以複製上面的範例,並將所有預留位置替換為您頁面的適當值。
必要的前言欄位
下表顯示所有必要欄位的描述
欄位 | 描述 |
---|---|
title | 頁面的標題。 |
description | 頁面上內容的單行描述。 |
weight | 頁面相對於目錄中其他頁面的順序。 |
keywords | 頁面上的關鍵字。Hugo 使用此清單來建立「另請參閱」下的連結。 |
aliases | 此頁面過去發佈時所使用的網址。請參閱下方「重新命名、移動或刪除頁面」以了解詳細資訊。 |
重新命名、移動或刪除頁面
當您移動或完全刪除頁面時,您必須確保指向這些頁面的現有連結仍然有效。前置元資料中的 aliases
欄位可協助您滿足此要求。請將移動或刪除前的頁面路徑加入 aliases
欄位。Hugo 會為我們的使用者實作從舊網址到新網址的自動重新導向。
在目標頁面(即您希望使用者進入的頁面)上,將原始頁面的 <path>
加入前置元資料,如下所示:
aliases:
- <path>
例如,您過去可以在 /help/faq
下找到我們的常見問題解答頁面。為了幫助使用者找到常見問題解答頁面,我們將該頁面向上移動了一層到 /faq/
,並以前置元資料進行了如下更改:
---
title: Frequently Asked Questions
description: Questions Asked Frequently.
weight: 13
aliases:
- /help/faq
---
上述變更允許任何使用者在造訪 https://istio.dev.org.tw/faq/
或 https://istio.dev.org.tw/help/faq/
時存取常見問題解答。
支援多個重新導向,例如:
---
title: Frequently Asked Questions
description: Questions Asked Frequently.
weight: 13
aliases:
- /faq
- /faq2
- /faq3
---
選用的前言欄位
然而,Hugo 支援許多前置元資料欄位,而此頁面僅涵蓋在 istio.io 上實作的欄位。
下表顯示最常用的選用欄位:
欄位 | 描述 |
---|---|
linktitle | 用於連結到此頁面的較短標題版本。 |
subtitle | 顯示在主標題下方的副標題。 |
icon | 顯示在標題旁邊的圖像路徑。 |
draft | 如果為 true,則該頁面不會顯示在網站的導覽中。 |
skip_byline | 如果為 true,Hugo 不會在主標題下方顯示署名。 |
skip_seealso | 如果為 true,Hugo 不會為該頁面產生「另請參閱」章節。 |
某些前置元資料欄位控制自動產生的目錄(ToC)。下表顯示這些欄位並說明如何使用它們:
欄位 | 描述 |
---|---|
skip_toc | 如果為 true,Hugo 不會為該頁面產生 ToC。 |
force_inline_toc | 如果為 true,Hugo 會將自動產生的 ToC 插入文字中,而不是在右側邊欄中。 |
max_toc_level | 設定 ToC 中使用的標題層級。值可以從 2 到 6。 |
remove_toc_prefix | Hugo 會從 ToC 中每個條目的開頭移除此字串。 |
有些前置元資料欄位僅適用於所謂的捆綁頁面。您可以識別捆綁頁面,因為它們的檔案名稱以底線 _
開頭,例如 _index.md
。在 Istio 中,我們使用捆綁頁面作為我們的章節登陸頁面。下表顯示與捆綁頁面相關的前置元資料欄位。
欄位 | 描述 |
---|---|
skip_list | 如果為 true,Hugo 不會自動產生章節頁面的內容磚。 |
simple_list | 如果為 true,Hugo 會使用簡單列表來自動產生章節頁面的內容。 |
list_below | 如果為 true,Hugo 會將自動產生的內容插入手動編寫的內容下方。 |
list_by_publishdate | 如果為 true,Hugo 會依發佈日期而不是權重排序自動產生的內容。 |
同樣地,某些前置元資料欄位專門適用於部落格文章。下表顯示這些欄位:
欄位 | 描述 |
---|---|
publishdate | 文章原始發佈的日期。 |
last_update | 文章上次進行重大修訂的日期。 |
attribution | 文章作者的選用名稱。 |
twitter | 文章作者的選用 Twitter 帳號。 |
target_release | 此部落格上使用的版本。通常,此值是在撰寫或更新部落格時,Istio 當前的主要版本。 |