附件族目录和文件

附件族目录

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

📂 modules
  📂 ROOT (1)
    📂 attachments (2)
      📄 attachment-source-file.ext (3)
    📁 images
    📁 pagesAlian
    📄 nav.adoc

1	根模块目录。
2	附件族目录。Antora 将存储在附件目录中的源文件分类为附件。
3	附件源文件。

附件目录是可选的。当生成站点时，Antora 将预设行为应用于存储在附件目录中的文件。

附件文件

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

在运行时，Antora自动：

将附件目录中的每个文件加载到 Antora 内容目录中，但标记为隐藏或缺少文件扩展名的文件除外
将每个加载的附件文件分配给附件族
为每个加载的附件分配一个惟一的资源ID，用于源到源引用
将每个加载的附件文件作为站点中的单个页面发布，但标记为未发布的文件除外

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

二进制和其它大文件

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

Assets

模块目录还可以包含名为 assets 的目录。这是另一种可选位置，由 Antora 识别，附件和图像族目录可以放置在这里。

📒 repository
  📄 antora.yml
  📂 modules
    📂 ROOT
      📂 assets
        📂 attachments
          📄 attachment-source-file.ext
        📂 images
          📄 image-source-file.ext
      📁 pagesAlian
      📄 nav.adoc

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

了解更多

Attachments