內容組織

本網站使用 Hugo。在 Hugo 中，內容組織是一個核心概念。

頁面清單

頁面順序

文件側邊選單、文件頁面瀏覽器等，都是使用 Hugo 的預設排序順序列出，該順序依權重（從 1 開始）、日期（最新優先）以及最後依連結標題排序。

鑑於此，如果您想要向上移動頁面或章節，請在頁面的 front matter 中設定權重

title: My Page
weight: 10

文件主選單

文件主選單是從 docs/ 下方的章節建立，並在 _index.md 章節內容檔案的 front matter 中設定 main_menu 旗標

main_menu: true

請注意，連結標題是從頁面的 linkTitle 擷取，因此如果您希望它與標題不同，請在內容檔案中變更它

main_menu: true
title: Page Title
linkTitle: Title used in links

文件側邊選單

文件側邊欄選單是從 docs/ 下方開始的目前章節樹狀結構建立。

它將顯示所有章節及其頁面。

如果您不想列出章節或頁面，請在 front matter 中將 toc_hide 旗標設定為 true

toc_hide: true

當您導覽到具有內容的章節時，會顯示特定章節或頁面（例如 _index.md）。否則，會顯示該章節內的第一個頁面。

文件瀏覽器

文件首頁上的頁面瀏覽器是使用直接位於 docs 章節 下方的所有章節與頁面建立。

如果您不想列出章節或頁面，請在 front matter 中將 toc_hide 旗標設定為 true

toc_hide: true

主選單

右上角選單以及頁尾中的網站連結是透過頁面查找建立的。這是為了確保頁面實際存在。因此，如果網站（語言）中不存在 case-studies 章節，則不會連結到它。

頁面套件

除了獨立內容頁面（Markdown 檔案）之外，Hugo 還支援頁面套件。

一個範例是 自訂 Hugo Shortcodes。它被視為葉節點套件。目錄下方的所有內容，包括 index.md，都將成為套件的一部分。這也包括頁面相關連結、可以處理的圖片等。

en/docs/home/contribute/includes
├── example1.md
├── example2.md
├── index.md
└── podtemplate.json

另一個廣泛使用的範例是 includes 套件。它在 front matter 中設定 headless: true，這表示它沒有自己的 URL。它僅在其他頁面中使用。

en/includes
├── default-storage-class-prereqs.md
├── index.md
├── partner-script.js
├── partner-style.css
├── task-tutorial-prereqs.md
├── user-guide-content-moved.md
└── user-guide-migration-notice.md

關於套件中檔案的一些重要注意事項

  • 對於翻譯後的套件，任何遺失的非內容檔案都將從上層語言繼承。這避免了重複。
  • 套件中的所有檔案都是 Hugo 所謂的 Resources，您可以為每種語言提供中繼資料，例如參數與標題，即使它不支援 front matter（YAML 檔案等）。請參閱 頁面資源中繼資料。
  • 您從 Resource 的 .RelPermalink 取得的值是頁面相關的。請參閱 永久連結。

樣式

本網站樣式表的 SASS 來源儲存在 assets/sass 中，並由 Hugo 自動建置。

下一步

上次修改時間為 2023 年 6 月 1 日下午 9:43 PST： 調整 content-organization.md 中的換行 (1ec7fe8e63)