示例目录和文件
示例家族目录
模块目录可以包含一个名为examples的家族目录。
📂 modules
📂 ROOT (1)
📂 examples (2)
📄 example-source-file.ext (3)
📁 pages
📄 nav.adoc
📂 named-module (4)
📂 examples (5)
📄 example-source-file (6)
📂 subdirectory-of-examples (7)
📄 example-source-file.ext
📁 images
| 1 | 一个 ROOT 模块目录。 |
| 2 | 一个examples家族目录。Antora将存储在examples目录中的源文件分类为示例。 |
| 3 | 一个示例源文件。 |
| 4 | 一个命名模块目录。 |
| 5 | 一个examples家族目录。 |
| 6 | 一个没有文件扩展名的示例源文件。Antora将没有扩展名的示例源文件加载到内容目录中。 |
| 7 | examples中的子目录。存储在examples目录的子目录中的源文件被分类为示例。 |
examples目录是可选的。Antora在生成站点时会对存储在examples目录中的源文件应用预设行为。
示例文件
Antora将存储在examples目录中的源文件分类为示例。示例文件通常包含内容，如源代码示例、终端输出、数据集等。
保存新示例文件时，请牢记以下文件名要求和建议：
-
示例文件的文件名不能包含空格，因为AsciiDoc的包含指令不接受带有空格的值。
-
不建议在文件名中使用大写字母。某些文件系统不区分大小写。因此，根据作者使用的文件系统，可能会发生文件冲突。
-
保存示例文件时，请使用有效的文件扩展名，除非对于特定文件类型，如Dockerfile，不使用扩展名是行业惯例。保存示例文件时不使用正确的文件扩展名可能会限制您应用某些Antora扩展或升级到未来功能的能力。
示例文件不需要具有文件扩展名。与作为隐藏文件处理的可发布资源不同，如果示例缺少文件扩展名，Antora将加载不带文件扩展名的示例到其内容目录，并为示例分配资源ID以供引用。
Antora不会将示例文件发布为单独的站点页面。要发布示例的内容，必须通过页面上的包含指令引用示例，或者最终包含在页面中的资源引用示例。
| 除非对于某种文件类型来说不具有文件扩展名是典型的，例如Dockerfile，最好将示例源文件保存为具有有效文件扩展名的文件。否则，您可能无法使用一些Antora或Asciidoctor扩展，这些扩展会对示例文件应用额外行为。 |
| 示例不应与AsciiDoc示例块混淆，尽管可以使用包含指令将示例文件插入到示例块中。 |