自定义标题
标题(title)键用于为组件版本(以及根据关系,组件)分配标题。标题是组件版本的正式的、面向用户的文本,通常是产品、项目或主题的适当名称。该标题还用于在默认 UI 的探索面板中对版本进行排序。
标题不影响页面和资源 id ,也不影响页面 URL 中的组件名称段。
title键
标题键是可选的。此键在组件版本的 antora.yml 文件中设置。该值由引用 UI 在任何引用组件或组件版本的地方使用,包括组件版本页面菜单、组件版本选择器和组件版本页面上的第一个面包屑位置。
虽然每个组件版本都设置了标题,但它应该在组件的所有版本中保持一致。Antora 使用最新版本的标题作为组件的标题。当查看特定版本时,例如在 breadcrumb 导航中,将显示该版本的标题。如果不同版本的标题不同,可能会使读者感到困惑。如果您确实需要在新版本中更改标题,并且您不想更新旧版本,则可以自定义 UI 模板以始终使用最新版本的标题。
如果没有设置 title ,则引用 UI 将使用组件名称( name 键的值)。与名称不同,title 的值可以包含空格,大写字母和更大范围的字符(例如,SUSE Manager
, APIkit
)。
name: colorado
title: Colorado ∆
version: '5.6'
当项目名称中包含破坏 Antora 页面和资源 id 的空格或字符,阻止 web 服务器之间的可移植性,或者不建议在 url 中使用此键时,此键非常有用。此外,如果项目的名称更改,您可以更改标题(title)键的值,但不必更新页面和资源 id 或重定向 url 。
为组件版本指定一个标题
让我们展开您之前学习了如何分配组件名称和版本 antora.yml 示例。项目的正式名称是 Silver Leaf ,团队希望这个名称显示在 UI 中。由于名称中不能包含空格,所以在组件版本的 antora.yml 文件中设置标题(title)。
-
在您选择的文本编辑器或 IDE 中打开组件版本 antora.yml 文件。
Example 2. Example 2. antora.yml for the component version silver-leaf 7.1name: silver-leaf version: '7.1'
-
在新行中输入
title
,后跟冒号(:
)。 -
在冒号后插入空白,然后键入要分配给 title 的值。
name: silver-leaf title: Silver Leaf version: '7.1'
-
保存文件。
现在,UI 将在组件版本页面菜单、组件版本选择器和页面面包屑中显示 Silver Leaf
。