模块目录和模块

什么是模块目录?

无论何处都需要modules目录,这是组件版本描述文件(antora.yml)所在的位置。

📒 仓库 (1)
  📄 antora.yml (2)
  📁 modules (3)
  📁 非文档目录 (4)
1 内容源根目录
2 必需的组件版本描述文件
3 必需的modules目录
4 Antora不会处理此目录中的文件,因为它位于modules目录之外

除了antora.yml之外,标准目录及其文件必须以有效的层次结构存在于modules目录中。一个modules目录可以包含您需要的多个模块目录

modules目录将文档源文件与配置文件、脚本、应用程序代码、测试和其他位于内容源根目录中的材料隔离开来。

什么是模块目录?

模块目录必须存储在一个modules目录中。一个模块目录存储页面、可重用文本和示例片段、图像和其他内容的源文件,位于family目录中。存储在模块目录中的源文件将成为组件版本中的一个模块的一部分。

📒 仓库
  📂 文档 (1)
    📄 antora.yml
    📂 modules
      📂 命名模块 (2)
        📂 页面 (3)
          📄 页面源文件.adoc (4)
        📄 nav.adoc (5)
1 内容源根目录
2 一个命名的模块目录
3 页面 family目录
4 一个页面的源文件
5 一个导航文件

至少,一个模块目录必须包含至少一个family目录,其中至少有一个源文件。一个模块目录还可以包含零个或多个导航文件。

有两种类型的模块目录:命名模块目录ROOT模块目录。在运行时,Antora会收集存储在ROOT和命名模块目录中的源文件,并将它们分配给模块。按照惯例,模块名称对应于模块文件夹的名称。

什么是模块?

一个模块是组件版本中相关概念、阶段、特性或其他项目特定分组的内容集合。虽然模块在发布站点中作为URL段表示,但它主要是作者的组织工具。模块无法单独配置(意味着它没有自己的元数据)。

模块名称和模块文件夹的名称相同。Antora将模块名称分配给模块文件夹中找到的所有文件。