资源和资源id
什么是资源ID
Antora 资源 ID,简称资源 ID,是一组独特可靠的识别坐标,以标准序列组织,Antora 自动从分配给每个资源源文件的属性中构建。您经常使用资源的资源 ID 来引用它从另一个资源。资源通过将其资源 ID 分配给 AsciiDoc xref
宏、include 指令
、 image 宏
,或者接受资源 ID 作为值的少数键、属性或选项来引用。然后 Antora 使用分配的资源 ID 在其虚拟文件系统中查找相应的资源。资源 ID 坐标描述了资源 ID 中的坐标,您在哪里找到资源的坐标以及何时使用每个坐标。
为什么资源id很重要
它们没有耦合到已发布的URL ,因为它们是源到源的引用。注意,页面坐标以 .adoc
结束,这是一个 AsciiDoc 源文件的文件扩展名。无论您是将站点部署到本地、staging环境还是生产环境,还是更改URL策略,资源ID始终保持不变。 xref
锁定目标页面并生成一个 URL
,该 URL
指向该页面发布的任何位置。
通过使用基于 Antora 的虚拟组件版本分类系统的标识符,它们最小程度地耦合到文件系统。
他们通过将资源指定为族相关目录路径来消除相对路径( ../../
)问题。即使参考资源位于族目录的子目录内,这条路径总是从族目录开始。
这个人性化的参考系统使你不必在写作时在头脑中进行计算。您只需指定要引用的页面的坐标。不需要担心源文件在磁盘上的物理位置或其发布的 URL 。您只需要知道组件、版本、模块和页面的名称,就可以填写这些信息。