自定义标题

使用title键为组件版本(以及相关的组件)分配标题。标题是组件版本的正式、面向用户的文本,通常是产品、项目或主题的正式名称。标题还用于默认UI的探索面板中对版本进行排序

标题不影响页面和资源ID,也不影响页面URL中的组件名称部分。

标题键

title键是可选的。此键在组件版本的antora.yml文件中设置。该值在引用UI中用于引用组件或组件版本的任何位置,包括组件版本页面菜单组件版本选择器以及组件版本页面上的第一个面包屑位置。

尽管标题是针对每个组件版本设置的,但它几乎总是在所有版本的组件中保持一致。Antora使用最新版本的标题作为组件的标题。在查看特定版本时,例如在面包屑导航中,将显示该版本的标题。如果各个版本之间的标题不同,可能会使读者感到困惑。如果确实需要在新版本中更改标题,并且不希望更新旧版本,可以自定义UI模板,始终使用最新版本的标题。

如果未设置title,引用UI将使用组件名称name键的值)代替。与name不同,title的值可以包含空格、大写字母和更广泛范围的字符(例如SUSE ManagerAPIkit)。

示例1. antora.yml
name: colorado
title: Colorado ∆
version: '5.6'

当项目名称包含空格或字符时,此键非常有用,这些字符会破坏Antora的页面和资源ID,阻止在Web服务器之间的可移植性,或者在URL中不建议使用。此外,如果项目名称发生更改,可以更改title键的值,而无需更新页面和资源ID或重定向URL。

为组件版本分配标题

让我们扩展之前学习的antora.yml示例,您之前学习了如何分配组件名称和版本。项目的官方名称是Silver Leaf,团队希望在UI中显示此名称。由于name不能包含空格,让我们在组件版本的antora.yml文件中设置title

  1. 在您选择的文本编辑器或IDE中打开组件版本的antora.yml文件。

    示例2. 用于组件版本 silver-leaf 7.1 的 antora.yml
    name: silver-leaf
    version: '7.1'
  2. 在新行上,输入title,直接跟着一个冒号(:)。

  3. 在冒号后插入一个空格,然后输入要分配给title的值。

    name: silver-leaf
    title: Silver Leaf
    version: '7.1'
  4. 保存文件。

现在,UI将在组件版本页面菜单、组件版本选择器和页面面包屑中显示Silver Leaf