來源檔案慣例

目錄

檔案名稱

當您為新內容建立新的 .md 檔案時，請確保

  • 檔案名稱盡可能簡短
  • 盡量將檔案名稱限制在一個或兩個字
  • 使用破折號分隔單字。例如
    • add-seats.md 和 remove-seats.md。
    • 建議使用 multiplatform-images 而不是 multi-platform-images。

Front matter

指定頁面的 front matter 位於 Markdown 檔案頂部，以三個連字號開頭和結尾的區塊中。它包含 YAML 內容。支援以下鍵值。標題、描述和關鍵字為必填。

鍵值必填描述
title是頁面標題。這會以 <h1> 標題層級新增到 HTML 輸出中。
description是描述頁面內容的句子。這會新增到 HTML 中繼資料。它不會呈現在頁面上。
keywords是以逗號分隔的關鍵字清單。這些會新增到 HTML 中繼資料。
aliases否應重新導向到目前頁面的頁面 YAML 清單。在建置時，這裡列出的每個頁面都會建立為包含 302 重新導向到此頁面的 HTML 虛設網頁。
notoc否true 或 false。如果為 true，則不會為此頁面的 HTML 輸出產生頁面內目錄。預設為 false。適用於某些沒有頁面內標題的著陸頁面。
toc_min否如果 notoc 設定為 true，則會忽略。頁面內目錄中包含的最小標題層級。預設為 2，以顯示 <h2> 標題為最小值。
toc_max否如果 notoc 設定為 false，則會忽略。頁面內目錄中包含的最大標題層級。預設為 3，以顯示 <h3> 標題。設定為與 toc_min 相同，僅顯示 toc_min 層級的標題。
sitemap否將頁面從搜尋引擎索引中排除。設定為 false 時，頁面會從 sitemap.xml 中排除，並且會將 <meta name="robots" content="noindex"/> 標題新增到頁面中。
sidebar.reverse否此區段頁面參數會變更該區段中頁面的排序順序。通常會按權重或標題出現在頂部的頁面，反而會出現在底部附近，反之亦然。
sidebar.goto否設定此選項可變更側邊欄應針對此項目指向的 URL。請參閱無分頁側邊欄項目。
sidebar.badge否設定此選項可將徽章新增到此頁面的側邊欄項目。此參數選項包含兩個欄位：badge.text 和 badge.color。

以下是有效（但人為設計的）頁面中繼資料範例。front matter 中中繼資料元素的順序並不重要。

---
description: Instructions for installing Docker Engine on Ubuntu
keywords: requirements, apt, installation, ubuntu, install, uninstall, upgrade, update
title: Install Docker Engine on Ubuntu
aliases:
- /ee/docker-ee/ubuntu/
- /engine/installation/linux/docker-ce/ubuntu/
- /engine/installation/linux/docker-ee/ubuntu/
- /engine/installation/linux/ubuntu/
- /engine/installation/linux/ubuntulinux/
- /engine/installation/ubuntulinux/
- /install/linux/docker-ce/ubuntu/
- /install/linux/docker-ee/ubuntu/
- /install/linux/ubuntu/
- /installation/ubuntulinux/
toc_max: 4
---

主體

頁面主體（關鍵字除外）從 front matter 之後開始。

文字長度

分割長行（最好最多 80 個字元）可以更輕鬆地提供關於小段文字的回饋。

無分頁側邊欄項目

如果您想將項目新增到側邊欄，但希望連結指向其他位置，則可以使用 sidebar.goto 參數。這與將 build.render 設定為 always 搭配使用時很有用，這會在側邊欄中建立一個無分頁項目，連結到另一個頁面。

---
title: Dummy sidebar link
build:
  render: never
sidebar:
  goto: /some/other/page/
weight: 30
---