家庭目录和家庭

Antora为存储在家庭目录中的源文件分配了预设的、特定于内容的行为。

什么是家庭目录?

家庭目录将共享相同功能、处理要求和发布规则的源文件分组在一起。Antora识别五个标准的家庭目录: attachments, examples, images, pages, 和 partials

📒 仓库
  📄 antora.yml
  📂 模块
    📂 命名模块
      📁 附件
      📁 示例
      📁 图像
      📁 页面
      📁 部分

每个家庭目录都是可选的。只有当您有应存储在特定家庭目录中的源文件时,才需要创建家庭目录。也就是说,如果一个模块没有任何图像文件,就不要创建一个 images 目录。在 模块目录 的根目录下设置您需要的家庭目录。在运行时,Antora会收集存储在家庭目录中的源文件,并将它们分配给相应的 家庭

什么是家庭?

家庭 是Antora对从家庭目录中收集的每个源文件应用的分类。分配的家庭对应于家庭目录的名称。这些家庭包括:

每个源文件根据其分配的家庭配置、转换和发布,符合预设的行为。

分配给家庭的源文件通常被称为 资源。Antora为其目录的每个资源分配一个由五个坐标组成的 独特的Antora资源ID。资源ID的一个坐标代表资源的家庭。