存储库和内容源根

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

Git存储库和内容源

包含站点内容的源文件存储在一个或多个 git 存储库中。这些存储库可以是远程的、本地的,或者两者的组合。在 playbook 文件中,您将输入几个参数( url、git 引用和开始路径),以便 1)允许 Antora 定位并连接到您的内容源存储库;2)为 Antora 提供位置标准,该标准可以解析到 git 存储库中的一个或多个内容源根。

如果存储库是本地的,默认情况下,如果当前分支与内容源上定义的分支之一匹配,Antora 将尝试使用该存储库的工作树。这种行为是可配置的。Antora 要求本地目录是 git 存储库(从而使本地目录成为工作树)。但是,你可以在那个位置初始化一个空的存储库,然后 Antora 就可以使用它了(例如,git init . && git commit --allow-empty - init )。

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

什么是内容源根?

内容源根是存储库分支或标记(即引用)中的位置,Antora 从这里开始查找内容源文件。可以把内容源根看作 Antora 商店的入口。从内容源根目录中,Antora 查找一个 Antora.yml 文件,它标识组件版本桶(bucket),然后扫描在一组 标准目录 中组织的源文件集合,以添加到该桶中。

一个存储库可以有许多内容源根。每个分支或标记可以有一个内容源根。或者,您可以使用 多个开始路径 定义每个分支或标记的多个内容源根。你也可以将两者结合起来。在哪里存储内容源根由您决定。