內容組織
本站使用 Hugo。在 Hugo 中,內容組織是一個核心概念。
注意
Hugo 提示: 使用hugo server --navigateToChanged
啟動 Hugo 以進行內容編輯會話。頁面列表
頁面順序
文件側邊選單、文件頁面瀏覽器等列表使用 Hugo 的預設排序順序,即按權重(從 1 開始)、日期(最新在前)排序,最後按連結標題排序。
鑑於此,如果您想將頁面或部分向上移動,請在頁面的 front matter 中設定一個權重。
title: My Page
weight: 10
注意
對於頁面權重,最好不要使用 1、2、3...,而是使用其他間隔,例如 10、20、30...。這樣您以後就可以在需要時插入頁面。此外,同一目錄(部分)內的每個權重都不應與其他權重重疊。這可以確保內容始終正確組織,尤其是在本地化內容中。文件主選單
Documentation
主選單由 docs/
下的各個部分構建,這些部分的 _index.md
內容檔案 front matter 中設定了 main_menu
標誌。
main_menu: true
請注意,連結標題是從頁面的 linkTitle
中獲取的,因此如果您希望它與標題不同,請在內容檔案中進行更改。
main_menu: true
title: Page Title
linkTitle: Title used in links
注意
以上操作需要按語言分別進行。如果您未在選單中看到您的部分,可能是因為它未被 Hugo 識別為一部分。請在部分資料夾中建立一個_index.md
內容檔案。文件側邊選單
文件側邊欄選單由 docs/
下方的當前部分樹構建。
它將顯示所有部分及其頁面。
如果您不想列出某個部分或頁面,請在 front matter 中將 toc_hide
標誌設定為 true
。
toc_hide: true
當您導航到一個有內容的節時,將顯示該特定節或頁面(例如 _index.md
)。否則,將顯示該節內的第一個頁面。
文件瀏覽器
文件主頁上的頁面瀏覽器使用 docs
部分下方的所有部分和頁面來構建。
如果您不想列出某個部分或頁面,請在 front matter 中將 toc_hide
標誌設定為 true
。
toc_hide: true
主選單
右上角選單(以及頁尾)中的站點連結是透過頁面查詢構建的。這是為了確保頁面實際存在。因此,如果某個站點(語言)不存在 case-studies
部分,它將不會被連結。
頁面包
除了獨立的 Content Pages(Markdown 檔案)之外,Hugo 還支援 頁面包。
一個例子是 自定義 Hugo Shortcodes。它被視為一個 leaf bundle
。目錄下的所有內容,包括 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 自動構建。
下一步
- 瞭解 自定義 Hugo Shortcodes
- 瞭解 樣式指南
- 瞭解 內容指南