原始檔約定

目錄

檔名

建立用於新內容的新 .md 檔案時，請確保

  • 檔名儘可能短
  • 嘗試將檔名保持為一個或兩個單詞
  • 使用破折號分隔單詞。例如
    • add-seats.md 和 remove-seats.md。
    • 首選 multiplatform-images 而非 multi-platform-images。

前置元資料

給定頁面的前置元資料位於 Markdown 檔案的頂部，以三個連字元開頭和結尾。它包含 YAML 內容。支援以下鍵。title、description 和 keywords 是必需的。

鍵必需描述
title是頁面標題。這將作為 <h1> 級別的標題新增到 HTML 輸出中。
description是描述頁面內容的句子。這將新增到 HTML 元資料中。它不會呈現在頁面上。
keywords是以逗號分隔的關鍵詞列表。這些將新增到 HTML 元資料中。
aliases否一個 YAML 頁面列表，這些頁面應重定向到當前頁面。在構建時，此處列出的每個頁面都將建立為一個 HTML 存根，其中包含指向此頁面的 302 重定向。
notoc否可以是 true 或 false。如果為 true，則不會為此頁面的 HTML 輸出生成頁內目錄 (TOC)。預設為 false。適用於一些沒有頁內標題的著陸頁。
toc_min否如果 notoc 設定為 true 則忽略。頁內目錄 (TOC) 中包含的最低標題級別。預設為 2，以顯示 <h2> 標題作為最低級別。
toc_max否如果 notoc 設定為 false 則忽略。頁內目錄 (TOC) 中包含的最高標題級別。預設為 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。

這是一個有效的（但並非真實的）頁面元資料示例。前置元資料中元資料元素的順序並不重要。

---
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
---

正文

頁面正文（除了關鍵詞）從前置元資料之後開始。

文字長度

分割長行（最好不超過 80 個字元）可以更容易地針對小塊文字提供反饋。

無頁面側邊欄條目

如果您想在側邊欄新增一個條目，但希望連結指向其他位置，可以使用 sidebar.goto 引數。這與將 build.render 設定為 always 結合使用很有用，後者會在側邊欄建立一個指向另一頁面的無頁面條目。

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