源文件约定
目录
文件名
创建新的 .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
---