前言
页眉是每个文件顶部三条破折号之间的 YAML 代码,它提供了对我们内容的重要管理选项。例如,页眉允许我们确保现有链接在页面被移动或完全删除后仍然有效。本页解释了目前 Istio 中页眉可用的功能。
以下示例显示了一个页眉,其中所有必填字段都用占位符填充
---
title: <title>
description: <description>
weight: <weight>
keywords: [<keyword1>,<keyword2>,...]
aliases:
- <previously-published-at-this-URL>
---
您可以复制上面的示例,并将所有占位符替换为您页面中的相应值。
必需的前言字段
下表显示了所有 **必填** 字段的描述
字段 | 描述 |
---|---|
title | 页面的标题。 |
description | 页面上内容的一句话描述。 |
weight | 页面相对于目录中其他页面的顺序。 |
keywords | 页面上的关键词。Hugo 使用此列表创建“另请参见”下的链接。 |
aliases | 页面过去发布的 URL。有关此项的详细信息,请参见下面的 重命名、移动或删除页面 |
重命名、移动或删除页面
当您移动或完全删除页面时,您必须确保指向这些页面的现有链接继续有效。页眉中的 aliases
字段可以帮助您满足此要求。在移动或删除之前将页面路径添加到 aliases
字段中。Hugo 为我们的用户实现了从旧 URL 到新 URL 的自动重定向。
在 **目标页面** 上,即您希望用户到达的页面,将 **原始页面** 的 <path>
添加到页眉中,如下所示
aliases:
- <path>
例如,您过去可以在 /help/faq
下找到我们的常见问题解答页面。为了帮助我们的用户找到常见问题解答页面,我们将页面向上移动了一级到 /faq/
,并将页眉更改如下
---
title: Frequently Asked Questions
description: Questions Asked Frequently.
weight: 13
aliases:
- /help/faq
---
上面的更改允许任何用户在访问 https://istio.ac.cn/faq/
或 https://istio.ac.cn/help/faq/
时访问常见问题解答。
支持多个重定向,例如
---
title: Frequently Asked Questions
description: Questions Asked Frequently.
weight: 13
aliases:
- /faq
- /faq2
- /faq3
---
可选的前言字段
然而,Hugo 支持许多页眉字段,本页只涵盖了 istio.io 上实现的那些字段。
下表显示了最常用的 **可选** 字段
字段 | 描述 |
---|---|
linktitle | 标题的简短版本,用于指向页面的链接。 |
subtitle | 显示在主标题下方的一个副标题。 |
icon | 指向显示在标题旁边的图像的路径。 |
draft | 如果为真,则页面不会显示在网站的导航中。 |
skip_byline | 如果为真,则 Hugo 不会在主标题下方显示作者署名。 |
skip_seealso | 如果为真,则 Hugo 不会为页面生成“另请参见”部分。 |
某些页眉字段控制自动生成的目录(ToC)。下表显示了这些字段,并解释了如何使用它们
字段 | 描述 |
---|---|
skip_toc | 如果为真,则 Hugo 不会为页面生成 ToC。 |
force_inline_toc | 如果为真,则 Hugo 将自动生成的 ToC 插入文本中,而不是插入右侧的边栏中。 |
max_toc_level | 设置 ToC 中使用的标题级别。值可以从 2 到 6。 |
remove_toc_prefix | Hugo 会从 ToC 中每个条目的开头删除此字符串 |
某些页眉字段仅适用于所谓的 **捆绑页面**。您可以识别捆绑页面,因为它们的文件名以下划线 _
开头,例如 _index.md
。在 Istio 中,我们使用捆绑页面作为我们的部分着陆页。下表显示了与捆绑页面相关的页眉字段。
字段 | 描述 |
---|---|
skip_list | 如果为真,则 Hugo 不会自动生成部分页面的内容标题。 |
simple_list | 如果为真,则 Hugo 会为部分页面的自动生成内容使用简单列表。 |
list_below | 如果为真,则 Hugo 会将自动生成的内容插入手动编写的內容下方。 |
list_by_publishdate | 如果为真,则 Hugo 会按发布日期对自动生成的内容进行排序,而不是按权重进行排序。 |
类似地,某些页眉字段专门适用于博客文章。下表显示了这些字段
字段 | 描述 |
---|---|
publishdate | 帖子最初发布的日期 |
last_update | 帖子最后一次收到重大修订的日期 |
attribution | 帖子的作者的可选姓名 |
twitter | 帖子的作者的可选 Twitter 句柄 |
target_release | 此博客中使用的版本。通常,此值是博客创作或更新时当前的主要 Istio 版本。 |