字体格式将会告诉页面在 Markdown 文件的最上端,使用 3 个横线作为开始和结束。其中包括有 YAML 内容,下面为可以支持的关键字,包括有表头,描述和关键字是否是必须的。
关键字 | 是否必须 | 描述 |
---|---|---|
title | 是 | 这个字段定义的是页面的标题,将会添加到 HTML 输出中的 <h1> 级别的头部。 |
description | 是 | 一个描述页面内容的例子,将会添加到 HTML 的 metadata 上面。 |
keywords | 是 | 一个使用逗号分隔符的关键字列表,将会添加到 HTML 的 metadata 上面。 |
redirect_from | 否 | 一个 YAML 的列表,这个将会显示链接到当前页面的的所有页面列表。在页面处理的过程中,这个地方配置的页面内容,将会为那些页面创建一个 302 重定向链接到这个页面上。 |
notoc | 否 | 可以使用 true 或者 false 。如果选择 true 的话, TOC 将不会在 HTML 输出的时候创建。默认的配置选项是 false 。针对没有页面头部内容,将会创建相同的显示页面。 |
toc_min | 否 | 如果 notoc 设置为 true 的话,这个选项将会被忽略。包括在页面 TOC 中头部,最小的页面级别为。默认配置为 2 , 意思是显示页面头部最小的开始为 <h2> 。 |
toc_max | 否 | 如果 notoc 设置为 false 的话,这个选项将会被忽略。包括在页面 TOC 中头部,最大的页面级别为。默认配置为 3 , 意思是显示页面头部最小的开始为 <h3> 。如果这个设置和 toc_min 相同的话,那么只有 toc_min 的级别标题被显示。 |
no_ratings | 否 | 可以使用 true 或者 false 。设置是否为页面设置投票,如果设置为 true 的话,页面将不会显示投票。默认为 false 。 |
skip_read_time | 否 | 设置 true 的话,将不会在页面中设置页面的估计阅读时间。 |
sitemap | 否 | 通知这个页面将不会被搜索引擎进行索引,当设置为 false 的时候,这个页面将会从 sitemap.xml 中进行剔除,并且在页面的头部(header)将会添加 <meta name="robots" content="noindex"/> 这个内容。 |
下面显示的内容是一个有效的页面 Metadata 配置(没有转换为 HTML)页面。在预页面格式中内容的顺序是没有关系的,你可以随意调整上面参数的顺序。
---
description: Instructions for installing Docker on Ubuntu
keywords: requirements, apt, installation, ubuntu, install, uninstall, upgrade, update
redirect_from:
- /engine/installation/ubuntulinux/
- /installation/ubuntulinux/
- /engine/installation/linux/ubuntulinux/
title: Get Docker for Ubuntu
toc_min: 1
toc_max: 6
skip_read_time: true
no_ratings: true
---
上图显示的是一个预页面格式。