ROOT Module Directory :: Antora Docs

什么是 ROOT 模块目录？

ROOT 目录是一个可选的模块目录。一个 ROOT 模块目录位于一个modules 目录中，其名称必须使用大写字母。一个 ROOT 目录中存储内容源文件，这些文件位于一个或多个family 目录中。

📒 仓库
  📂 文档 (1)
    📄 antora.yml (2)
    📂 模块 (3)
      📂 ROOT (4)
        📂 页面 (5)
          📄 index.adoc (6)
          📄 another-page.adoc (7)
        📄 nav.adoc (8)

1	内容源根目录
2	必需的 antora.yml 文件
3	必需的 modules 目录
4	ROOT 模块目录
5	pages family 目录
6	默认组件版本起始页的源文件
7	ROOT 模块中的另一个页面的源文件
8	一个导航文件

如果存在 ROOT 模块目录，则必须至少包含一个带有至少一个源文件的family 目录。它还可以包含一个可选的导航文件。

存储在 ROOT 目录中的源文件将成为组件版本中的一个ROOT 模块的一部分。我们建议您创建一个 ROOT 模块目录，因为 Antora 对 ROOT 模块中的可发布资源应用特殊的预设行为。例如，pages 目录中的源文件 index.adoc 将成为组件版本的默认起始页。熟悉 HTML 网站托管术语的人会认识到这是组件版本的索引页。

小型文档项目可能永远不需要超过一个 ROOT 模块目录。但是，随着项目的增长，您可以轻松地添加更多模块目录，并逐渐重新组织您的源文件。尽管额外的结构现在看起来有些多余，但从长远来看，您会因为给予内容增长的空间而感到高兴。

什么是 ROOT 模块？

存储在 ROOT 目录中的源文件将成为一个名为 ROOT 的模块的一部分，该模块位于组件版本中。ROOT 模块的页面将成为组件版本的顶级页面。换句话说，与其他模块不同，ROOT 模块的名称不会在生成的站点中使用。

您可以将名称“ROOT”视为空模块名称的别名（即，没有模块段）。使用此特殊值允许所有模块成为同级。

在仔细考虑存储在 ROOT 模块目录中的文件时很重要，因为它们有可能与命名模块目录中的文件发生冲突。通常，由于这个原因，ROOT 模块不使用主题文件夹。

ROOT 模块名称在哪里使用？

当您从另一个模块或组件版本引用属于 ROOT 模块的内容时，您将在页面、附件、图片、示例和部分资源的资源 ID中指定模块名称 ROOT。在指定时，ROOT 总是以大写字母书写。

由于 Antora 将 ROOT 模块中的页面视为顶级组件版本页面，因此在页面 URL 的模块段中不显示模块名称 ROOT。