源文件规范
目录
文件名
创建新的 .md 文件以添加新内容时，请确保
- 文件名尽可能简短
- 尽量将文件名限制在一个或两个单词
- 使用短横线分隔单词。例如
add-seats.md和remove-seats.md。multiplatform-images比multi-platform-images更佳。
前置内容
给定页面的前置内容位于 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。 |
这是一个有效的（但人为的）页面元数据的示例。前置内容中元数据元素的顺序并不重要。
---
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
---