根模块目录

什么是ROOT模块目录

ROOT 目录是一个可选的模块目录。ROOT 模块目录位于模块(modules)目录中，其名称必须全部用大写字母书写。根目录将内容源文件存储在一个或多个家族(family)目录中。

📒 repository
  📂 docs (1)
    📄 antora.yml (2)
    📂 modules (3)
      📂 ROOT (4)
        📂 pagesAlian (5)
          📄 index.adoc (6)
          📄 another-page.adoc (7)
        📄 nav.adoc (8)

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

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

在组件版本中，存储在 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 模块中的页面是顶级组件版本页面，因此模块名 ROOT 不会显示在其页面 url 的模块段中。