源文件约定

目录

文件名

创建用于新内容的新 .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
---
页面选项