文档标题

在本页面中,您将学到:

  • 如何创建文档标题

  • 如何指定页面标题

  • 如何设置标题属性

文档标题

在 AsciiDoc 中,页面顶部的属性条目(可选)前面可以是一个零级部分标题,隐式创建一个文档标题。文档标题中的零级部分标题称为文档标题,简称为 doctitle。文档标题中的属性条目设置(或取消设置)在整个文档中可用的属性。

AsciiDoc 文档中的文档标题用作 Antora 中的页面标题。

Antora 仅支持 AsciiDoc 的 Atx 样式标题语法,这意味着页面标题必须在 Atx 标记之前,即等号标记(=)后跟一个空格。Antora 不识别 AsciiDoc 中曾经支持的传统 Setext 样式(即下划线)标题语法,也不识别 Asciidoctor 的 Markdown 样式标题语法。如果您不使用 Atx 样式语法,页面中的交叉引用将无法解析,并且 AsciiDoc 的其他功能也将不可用。

以下是文档标题的示例:

= 页面标题
:description: 此页面的描述。

在 Antora 中,所有页面必须有一个页面标题。这意味着 doctitle,因此文档标题是必需的。有关指定页面标题的更多信息,请参阅 添加标题和元数据

如果您需要为页面应用一组独特的 CSS,您可以向 doctitle 添加一个角色,如下所示。

= 首页
:docrole: home

假设您使用的 UI 支持它,现在您可以使用 body.home 选择器来配置 CSS 以针对此特定页面。

标题属性

标题属性是与文档标题相关联的全文档 AsciiDoc 属性,因此与文档元数据相关。一些标题属性可用于控制页面的处理,例如 page-toclevels。更常见的是,标题属性用于存储文档中可重用的内联内容。

文档标题隐式地在第一个空行结束。因此,在此行以下的任何属性条目将不被视为标题属性。

有几个内置的标题属性可用于控制发布页面中的元数据。请参阅 添加标题和元数据 了解这些属性。

标题属性可以通过在名称前加上 page- 前缀提升为页面属性。从页面布局模板中的 UI 模型中可以访问 页面属性,因此可以控制页面的形成方式。