存储库和内容源根

Antora从git存储库的分支、标签和工作树中的目录中收集内容源文件。只有当Antora能够在内容源根中定位它们时,这些源文件才能被正确检索和处理。

git存储库和内容源

包含站点内容的源文件存储在一个或多个git存储库中。这些存储库可以是远程的、本地的,或两者的组合。在playbook文件中,您将输入几个参数(例如url、分支、标签和起始路径),这些参数:

  1. 允许Antora定位并连接到您的内容源存储库,以及

  2. 为Antora提供解析为一个或多个内容源根的位置标准。

如果存储库是本地的,默认情况下,如果当前分支与内容源上定义的一个分支匹配,Antora将尝试使用该存储库的工作树。这种行为是可配置的。

Antora要求本地目录是一个git存储库,这意味着本地目录是一个git工作树。git存储库本身可以是空的,这意味着您不必提交任何文件就可以工作。如果本地目录尚未是git存储库,您可以通过运行以下命令使其成为一个:

$ git init . && git commit --allow-empty -m init

在配置站点playbook之前,您需要确定在存储库中设置内容源根的位置。

什么是内容源根?

内容源根是存储库中的一个分支或标签(即一个引用)中的位置,从那里Antora开始查找内容源文件。将内容源根视为Antora购物的商店入口。从内容源根开始,Antora查找一个antora.yml文件,该文件标识组件版本存储桶,然后扫描一组组织在标准目录集中的源文件,以添加到该存储桶中。

一个存储库可以有许多内容源根。您可以每个分支或标签拥有一个内容源根。或者您可以使用多个起始路径定义每个分支或标签上的多个内容源根。您也可以两者兼而有之。存储内容源根的位置由您决定。