UI Bundle URL
UI捆绑包是一个包含一个或多个站点UI的ZIP存档或目录。UI捆绑包中唯一必需的文件是页面的默认布局(例如,layouts/default.hbs)(如果启用了404页面,则还有layouts/404.hbs)。Antora在生成站点时会自动获取和加载UI捆绑包。
url键
url
键是必需的。此键在playbook的ui类别键的bundle键下配置。url
键接受Antora可以定位和获取站点UI捆绑包的URL或文件系统路径。文件系统路径必须指向ZIP存档或本地目录,其中ZIP存档已被解压缩。
ui: (1)
bundle: (2)
url: https://repo.org/path/to/a-ui-bundle.zip (3)
1 | 输入父键ui ,后跟冒号(: ),然后按Enter。 |
2 | bundle 键是ui 的子级。输入键的名称bundle ,后跟冒号(: ),然后按Enter。 |
3 | url 键是bundle 的子级。输入url ,后跟冒号和一个空格(: ),然后输入URL或文件系统路径值。 |
另外,url
键可以从CLI中分配。
可以使用补充UI来增强UI捆绑包。
加载远程捆绑包
当url
的值是远程URL时,Antora在第一次运行时会下载并缓存UI捆绑包。在这种情况下,目标必须是ZIP存档。
ui:
bundle:
url: https://repo.org/path/to/a-ui-bundle.zip
UI捆绑包基于URL的签名进行缓存。在后续运行中,只要url
的值保持不变,Antora就会从缓存中加载捆绑包。这样可以避免Antora每次生成站点时都需要下载捆绑包。
使用快照
如果UI捆绑包存在于缓存中,Antora不会再次下载该捆绑包,即使启用了fetch。如果url
的值保持不变,但它指向的存档随时间变化,那么UI捆绑包需要被标识为快照以绕过此缓存。
为了在不更改url
值的情况下检索UI捆绑包更新,需要在url
键旁边启用snapshot
键。默认情况下,快照未启用(设置为false
)。当快照设置为true
时,Antora将在启用playbook的runtime
类别下的fetch
键时下载UI捆绑包。fetch
键指示Antora检索更新(包括UI捆绑包快照)。
ui:
bundle:
url: https://gitlab.com/antora/antora-ui-default/-/jobs/artifacts/HEAD/raw/build/ui-bundle.zip?job=bundle-stable
snapshot: true
如果您正在使用Antora的参考UI捆绑包,应将该捆绑包标记为快照,因为其URL永远不会更改。 |
如果要控制Antora何时检索更新,请在调用antora
命令时传递--fetch
选项。要使此设置永久生效,请在playbook中设置runtime.fetch
键为true
。
runtime:
fetch: true
只有在引用远程捆绑包时(Antora默认缓存)才需要快照键。如果引用的是文件系统中的捆绑包,Antora将始终使用指定的文件。
从文件系统加载捆绑包
url
键可以使用绝对或相对文件系统路径引用本地UI捆绑包。
ui:
bundle:
url: ./../docs-ui/build/ui-bundle.zip
相对路径将根据以下规则扩展为绝对路径:
-
如果第一个路径段是波浪号(
~
),则剩余路径将相对于用户的主目录解析。 -
如果第一个路径段是点(
.
),则剩余路径将相对于playbook文件的位置解析。 -
如果第一个路径段是紧接着加号的波浪号(
~+
),或者不以前述前缀开头,则剩余路径将相对于当前工作目录解析。
以下是使用绝对路径的相同UI捆绑包路径。
ui:
bundle:
url: /home/user/projects/docs-ui/build/ui-bundle.zip
以下是UI捆绑包已解压缩的位置(或其布局与已解压缩存档相同)的路径。
ui:
bundle:
url: ./../docs-ui/build/ui-bundle-extracted
从本地目录加载UI捆绑包是调试逻辑的好方法。