原始檔約定
目錄
檔名
建立新的 .md 檔案以新增新內容時，請確保：
- 檔名儘可能短
- 儘量將檔名保持在一個詞或兩個詞
- 使用連字元分隔單詞。例如：
add-seats.md和remove-seats.md。multiplatform-images優於multi-platform-images。
前言
給定頁面的前言部分位於 Markdown 檔案頂部，以三個連字元開頭和結尾。它包含 YAML 內容。支援以下鍵。標題、描述和關鍵字是必需的。
| 金鑰 | 必需 | 描述 |
|---|---|---|
| title | 是 | 頁面標題。這會作為 <h1> 級別的標題新增到 HTML 輸出中。 |
| description | 是 | 描述頁面內容的句子。這會新增到 HTML 元資料中。它不會呈現在頁面上。 |
| 關鍵詞 | 是 | 逗號分隔的關鍵詞列表。這些將新增到 HTML 元資料中。 |
| 別名 | no | 一個 YAML 頁面列表，這些頁面應重定向到當前頁面。在構建時，此處列出的每個頁面都會建立一個包含 302 重定向到此頁面的 HTML 存根。 |
| notoc | no | true 或 false。如果為 true，則此頁面的 HTML 輸出不會生成頁內 TOC。預設為 false。適用於某些沒有頁內標題的著陸頁。 |
| toc_min | no | 如果 notoc 設定為 true，則忽略此項。頁內 TOC 中包含的最小標題級別。預設為 2，以顯示 <h2> 標題作為最小級別。 |
| toc_max | no | 如果 notoc 設定為 false，則忽略此項。頁內 TOC 中包含的最大標題級別。預設為 3，以顯示 <h3> 標題。將其設定為與 toc_min 相同，以僅顯示 toc_min 級別的標題。 |
| sitemap | no | 將頁面從搜尋引擎索引中排除。當設定為 false 時，頁面將從 sitemap.xml 中排除，並且會在頁面中新增 <meta name="robots" content="noindex"/> 標頭。 |
| sidebar.reverse | no | 此引數用於部分頁面，它會改變該部分中頁面的排序順序。通常按權重或標題顯示在頂部的頁面將改為顯示在底部，反之亦然。 |
| sidebar.goto | no | 設定此項可更改側邊欄應為此條目指向的 URL。請參閱無頁面側邊欄條目。 |
| sidebar.badge | no | 設定此項可為該頁面的側邊欄條目新增徽章。此引數選項包含兩個欄位：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
---