资源和资源ID

什么是资源?

资源是属于页面、图片、部分、示例或附件系列的源文件。Antora为每个资源分配一个称为Antora资源ID的唯一标识符。

什么是可发布的资源?

可发布的资源是属于页面、附件或图片系列的源文件。Antora会自动发布页面、附件和图片文件到您的站点,即使它们没有在其他资源中被引用。这与部分和示例文件形成对比。部分或示例的内容只有在被引用时才会被发布——无论是直接引用还是通过最终被引用的另一个部分或示例间接引用。

什么是资源ID?

资源ID坐标描述了资源ID中的坐标,您可以在哪里找到资源的坐标,以及何时使用每个坐标。

资源ID为什么重要?

它们不与发布的URL耦合,因为它们是源到源的引用。请注意,页面坐标以.adoc结尾,这是AsciiDoc源文件的文件扩展名。无论您是将站点部署到本地、到暂存或生产环境,还是更改URL策略,资源ID始终保持不变。xref锁定目标页面并生成一个指向它的URL,无论它在何处发布。

它们通过基于Antora虚拟组件版本分类系统的标识符最小程度地与文件系统耦合

它们通过指定资源作为家族相对目录路径,消除了相对路径(../../)问题。路径始终从家族目录开始,即使引用资源位于家族目录的子目录中。

这种人性化的引用系统使您在撰写时无需进行头脑计算。您只需指定要引用的页面的坐标。无需担心源文件在磁盘上的物理位置或其发布的URL。您只需要知道您的组件、版本、模块和页面的名称,以便填写这些信息。

重复资源

  1. 位于多个内容源根目录中的antora.yml文件声明相同的名称和版本

  2. 两个内容源根具有至少一个位于相同相对路径(从起始路径开始)的文件

  3. 冲突文件都被Antora收集和分类

1.0@name-of-component中的重复导航:modules/ROOT/nav.adoc
    1:modules/ROOT/nav.adoc在https://git-host/repo-name.git(分支:v1.0.x)
    2:modules/ROOT/nav.adoc在https://git-host/repo-name.git(标签:v1.0.0)

1.0@name-of-component中的重复页面:modules/ROOT/index.adoc
    1:modules/ROOT/nav.adoc在https://git-host/repo-name.git(分支:v1.0.x)
    2:modules/ROOT/nav.adoc在https://git-host/repo-name.git(标签:v1.0.0)

分布式组件版本,在这种情况下,antora.yml将声明相同的名称和版本,则您需要从两个根目录中的一个中删除冲突的文件,以避免重叠。