附件目录和文件

附件家族目录

模块目录可以包含一个名为attachments的家族目录。

📂 modules
  📂 ROOT (1)
    📂 attachments (2)
      📄 附件源文件.ext (3)
    📁 images
    📁 pages
    📄 nav.adoc
1 一个 ROOT 模块目录。
2 一个attachments家族目录。Antora将存储在attachments目录中的源文件分类为附件。
3 一个附件源文件。

attachments目录是可选的。Antora在生成站点时会对存储在attachments目录中的文件应用预设行为。

附件文件

附件通常是站点访客使用其浏览器查看或下载的文件，例如PDF或示例项目的ZIP归档文件。

在运行时，Antora会自动执行以下操作：

  • 将attachments目录中的每个文件加载到Antora内容目录中，除了被标记为隐藏或缺少文件扩展名的文件

  • 将每个加载的附件文件分配给附件家族

  • 为每个加载的附件分配一个唯一资源ID，用于源到源的引用

  • 将每个加载的附件文件发布为站点中的单独页面，除了被标记为未发布的文件

使用附件的资源ID，您可以从站点中的其他页面、资源或导航文件中交叉引用附件。Antora在构建附件的URL时使用家族目录、attachments相对目录路径（如果存在）、附件的文件名和文件扩展名。

二进制文件和其他大文件

如果您的内容包含大型附件文件，例如示例项目的二进制文件、库文件或PDF文件，我们不建议将它们存储在常规的git存储库中。相反，应将它们托管在二进制存储库（如S3）中，或使用git LFS（大文件存储）。

资源

模块目录还可以包含一个名为assets的目录。这是Antora识别的另一个位置，可以在其中放置attachments和images家族目录。

📒 存储库
  📄 antora.yml
  📂 modules
    📂 ROOT
      📂 assets
        📂 attachments
          📄 附件源文件.ext
        📂 images
          📄 图像源文件.ext
      📁 pages
      📄 nav.adoc

您不需要在页面的标题中设置这些预定义目录的路径。这由Antora自动管理。

了解更多