添加标题和元数据

在本页面中，您将学到：

  • 如何添加页面标题。

  • 如何向页面添加元数据。

页面标题

页面标题由一个等号（=）指定，后跟一个空格，然后是标题的文本。

= 本页面的标题

每个页面都应该有一个页面标题。没有页面标题，页面就缺少了其身份的一个关键部分，Antora 中的某些功能将无法正常工作。如果您不想在某个页面上显示页面标题，可以在 UI 模板中添加条件逻辑来隐藏它。

页面标题可以包含基本文本格式。例如：

= 一个 _格式化的_ 页面标题

但是，页面标题不能包含资源引用，比如图片。页面标题在不同的上下文中使用，资源引用并不总是合适或可解析的。因此，它们是不允许的。

页面描述和关键字

如果设置了 description，则会将其输出到一个 HTML 的 <meta> 标签中。您可以通过在每行结尾添加一个以空格为前缀的反斜杠 \ 来跨越多行显示长值。

示例 1. 描述属性语法 
= 页面标题
:description: 存储在 HTML meta 标签中的页面描述。本页面是关于各种有趣事物的。

关键字属性包含一个逗号分隔的值列表，这些值分配给一个 HTML 的 <meta> 标签。

示例 2. 关键字属性语法 
= 页面标题
:keywords: 逗号分隔的值，存储在 HTML 的 meta 标签中

页面作者

指定页面的作者或作者是可选的。作者在页面标题的正下方列出。可选的电子邮件地址或联系 URL 可以在作者的名称后面用一对尖括号（< >）括起来。当页面有多个作者时，每个作者之间用分号（;）分隔。

示例 3. 多个作者和作者信息语法 
= 页面标题
名 中 姓 <author@email.com>; 名 姓 <author@email.com>

作者名称会输出到 HTML 的 <meta> 标签中。是否在发布页面上显示任何作者信息取决于站点的 UI 模板。

有关指定作者信息的其他属性和方法，请参考 AsciiDoc 文档中的附加作者属性。