示例

示例对于存储源代码、查询、配置参数、终端输出、日志、数据集以及其他非AsciiDoc文件非常有用，您可以在整个站点中的一个或多个页面中重复使用它们。您对示例文件所做的更改将在下次构建站点时传播到您引用示例的所有页面。

示例文件通常是非AsciiDoc文件。它们存储在一个示例目录中。

保存新示例文件时，请记住以下文件名要求和建议：

与可发布资源不同，没有文件扩展名的示例文件不会被视为隐藏文件。Antora将加载没有文件扩展名的示例文件到其内容目录中，并为引用分配一个资源ID。

Antora不会将示例文件发布为单独的站点页面。示例必须通过包含指令从页面或最终包含在页面中的资源引用，才能发布示例的内容。

通常，示例文件中的内容会被插入到源代码、列表和文字块中。无论示例文件属于哪个组件版本，它都可以被站点中的任何页面或部分引用。示例是通过其资源ID和AsciiDoc包含指令进行引用的。您甚至可以选择示例中的区域或行，而不是全部示例内容，并使用包含指令的tag、tags或lines属性仅插入那些区域或行。