源文件约定

文件名

当您为新内容创建新的 .md 文件时,请确保:

  • 文件名尽可能短
  • 尽量将文件名保持为一个或两个单词
  • 使用破折号来分隔单词。例如:
    • add-seats.mdremove-seats.md
    • multiplatform-images更喜欢multi-platform-images.

前言

给定页面的前面内容位于 Markdown 文件顶部的一个部分中,该部分以三个连字符开头和结尾。它包括 YAML 内容。支持以下键。标题、描述和关键字是必需的。

钥匙必需的描述
标题是的页面标题。这将作为级别标头添加到 HTML 输出中<h1>
描述是的描述页面内容的句子。这将添加到 HTML 元数据中。它不会呈现在页面上。
关键词是的以逗号分隔的关键字列表。这些被添加到 HTML 元数据中。
别名应重定向到当前页面的 YAML 页面列表。在构建时,此处列出的每个页面都会创建为包含指向该页面的 302 重定向的 HTML 存根。
诺托克两者任truefalse。如果true,则不会为此页面的 HTML 输出生成页内目录。默认为false.适用于一些没有页内标题的登陆页面。
最小目录notoc如果设置为 则忽略true。页内目录中包含的最低标题级别。默认为2, 以显示<h2>最小标题。
最大目录notoc如果设置为 则忽略false。页内目录中包含的最大标题级别。默认为3, 显示<h3>标题。设置为toc_min与仅显示toc_min标题级别相同。
跳过反馈设置true为禁用此页面的反馈小部件。
站点地图将该页面排除在搜索引擎索引之外。当设置为 时false,页面将被排除在外sitemap.xml,并且<meta name="robots" content="noindex"/>页眉将添加到页面中。

这是一个有效(但人为的)页面元数据的示例。前面的元数据元素的顺序并不重要。

---
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 个字符)可以更轻松地提供有关小文本块的反馈。