Name键

组件名称是通过给 name 键赋值来定义的。

什么是组件名称

组件名称，也称为名称，是在组件版本描述符文件( antora.yml )中分配给 name 键的值。组件名称通常表示项目、库、服务等的名称，例如 fauna 、 rudder 、 nrepl 等。名称(name)键的值与版本(version)键的值一起定义组件的版本。

Antora如何使用name键

组件名称是许多 Antora 操作的基础。 Antora 用了这个名字：

  • 作为页面和资产 url 中的组件段，除非该组件的名称是 ROOT 。

另外，如果没有设置组件标题键，Antora 将使用该名称：

  • 对组件版本进行排序

  • 用于在引用 UI 中显示，其中包括组件版本页面菜单、组件版本选择器菜单和组件版本页面上的第一个面包屑位置

请注意，组件名称是区分大小写的。这意味着如果您有两个名称相同但大小写不同的组件，Antora 会将它们视为不同的组件。

当引用另一个文档组件中的资源时，内容编写者使用该名称作为资源 id 中的组件坐标。

name 键

name 键是必需的。它是在组件版本描述符文件( antora.yml )中设置并赋值的。

Example 1. Example 1. antora.yml with defined component name
name: colorado (1)
1 在新行开头，输入 name ，后跟冒号和空格( : )。然后键入要分配给 name 的值。

name键值要求

name 键的取值可以包含字母、数字、_、- 和 .。为了确保主机平台之间的可移植性，name 值中使用的字母应该是小写的。

IMPORTANT

我们强烈建议您选择仅由小写字符组成的名称。除了特殊的 ROOT 值之外，组件名都在站点的 url 中使用，因此，使用一致的大小写可以使组件名以及站点更具可移植性。这是因为一些文件系统，以及在其上运行的 web 服务器，不能区分大写和小写字符。

该值不能包含空格、斜杠(/)或 HTML 特殊字符(& 、 < 或 > )。该值不能为空。

请参阅自定义标题，了解如何在站点 UI 中显示包含空格、大写字母和其他字符的名称。