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