Partials族目录和文件

Partials族目录

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

📂 modules
  📂 ROOT (1)
    📁 images
    📁 pagesAlian
    📂 partials (2)
      📄 partial-source-file.adoc (3)
    📄 nav.adoc
  📂 named-module (4)
    📁 pagesAlian
    📂 partials (5)
      📄 partial-source-file.adoc
      📂 subdirectory-of-partials (6)
        📄 partial-source-file.adoc
1 根模块目录。
2 partials族目录。Antora 将存储在 Partials 目录中的源文件作为部分分类。
3 用 ASCIIDOC 语法标记的部分文件，并用 .adoc 文件扩展名保存。
4 命名模块目录。
5 partials族目录。
6 部分子目录。存储在 partials 目录的子目录中的源文件被归类为部分。

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

Partial 文件

Antora 将存储在 partials 目录中的源文件分类为 partial 文件，或者简称为 partials 。Partials 通常是包含内容片段的 AsciiDoc 文件，例如插入到一个或多个页面或 Partials 中的公共描述或术语。然而，Antora 并不要求部分是 AsciiDoc 文件。

保存新的部分文件时，请记住以下文件名要求和建议：

  • 部分文件名不能包含空格，因为 AsciiDoc include 指令不接受带空格的值。

  • 文件名中不建议使用大写字母。有些文件系统不区分大小写。因此，根据写入器使用的文件系统不同，可能会发生文件冲突。

  • 如果是 AsciiDoc 文件，则使用 .adoc 扩展名保存部分文件，否则使用文件类型的有效文件扩展名。对于行业惯例中特定的文件类型没有扩展名，您应该只保存没有文件扩展名的部分。在保存部分文件时不使用正确的文件扩展名可能会限制您应用某些 Antora 扩展名或升级到未来功能的能力。

局部文件不需要有文件扩展名。与缺少文件扩展名的可发布资源被视为隐藏文件不同， Antora 会将没有文件扩展名的部分加载到其内容目录中，并为部分分配资源 ID 以供引用。

Antora 不将部分文件作为单独的站点页面发布。为了发布分部的内容，分部的内容必须由页面或最终包含在页面中的资源中的 include 指令引用。

IMPORTANT

除非文件类型通常没有文件扩展名，否则最好使用有效的文件扩展名保存部分源文件。

了解更多