添加标题和元数据

在此页面上，您将学习：

  • 如何添加页面标题。

  • 如何将元数据添加到页面。

页面标题

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

= Title of This Page

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

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

= A _Formatted_ Page Title

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

页面描述和关键字

如果设置，description 将输出到具有相同名称的 HTML <meta> 标记。您可以将长值分隔成几行，方法是每行以反斜杠 \ 结尾，并在其前面加一个空格。

Example 1. Example 1. Description attribute syntax
= Page Title
:description: A description of the page stored in an HTML meta tag. This page is \
about all kinds of interesting things.

keywords 属性包含一个逗号分隔的值列表，这些值被分配给具有相同名称的 HTML <meta> 标记。

Example 2. Example 2. Keywords attribute syntax
= Page Title
:keywords: comma-separated values, stored, in an HTML, meta, tag

页面作者

指定页面的作者是可选的。作者的名字列在页面标题的正下方。可选的电子邮件地址或联系 URL 可以在一组尖括号( < > )中跟在作者的名字后面。当一个页面有多个作者时，每个作者用分号( ; )分隔。

Example 3. Example 3. Multiple authors and author information syntax
= Page Title
First Middle Last <author@email.com>; First Last <author@email.com>

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

请参阅 AsciiDoc 文档了解用于指定作者信息的 其它作者属性 和方法。