局部目录和文件
局部家族目录
模块目录可以包含一个名为partials的家族目录。
📂 模块 📂 ROOT (1) 📁 图片 📁 页面 📂 局部 (2) 📄 局部源文件.adoc (3) 📄 导航.adoc 📂 命名模块 (4) 📁 页面 📂 局部 (5) 📄 局部源文件.adoc 📂 局部子目录 (6) 📄 局部源文件.adoc
1 | 一个ROOT模块目录。 |
2 | 一个partials家族目录。Antora将存储在partials目录中的源文件分类为局部。 |
3 | 一个使用AsciiDoc语法标记的局部文件,并以.adoc文件扩展名保存。 |
4 | 一个命名模块目录。 |
5 | 一个partials家族目录。 |
6 | partials中的子目录。存储在partials目录子目录中的源文件被分类为局部。 |
partials目录是可选的。当生成站点时,Antora会对存储在partials目录中的源文件应用预设行为。
局部文件
Antora将存储在partials目录中的源文件分类为局部文件,简称为局部。局部通常是包含内容片段的AsciiDoc文件,例如常见描述或术语,这些内容片段会被插入到一个或多个页面或局部中。但是,Antora不要求局部必须是AsciiDoc文件。
保存新的局部文件时,请牢记以下文件名要求和建议:
-
局部文件的文件名不能包含空格,因为AsciiDoc的包含指令不接受带有空格的值。
-
不建议在文件名中使用大写字母。某些文件系统不区分大小写。因此,根据作者使用的文件系统,可能会发生文件冲突。
-
当局部文件是AsciiDoc文件时,请使用.adoc扩展名保存,否则使用文件类型的有效文件扩展名。仅当特定文件类型的常见行业惯例是不使用扩展名时,才应该保存不带扩展名的局部文件。保存局部文件时不使用正确的文件扩展名可能会限制您应用某些Antora扩展或升级到未来功能的能力。
局部不需要具有文件扩展名。与如果缺少文件扩展名则被视为隐藏文件的可发布资源不同,Antora将加载没有文件扩展名的局部文件到其内容目录中,并为其分配一个资源ID以供引用。
Antora不会将局部文件作为单独的站点页面发布。要发布局部内容,必须通过包含指令从页面或最终包含在页面中的资源引用局部。
除非某种文件类型通常不具有文件扩展名,否则最好将局部源文件保存为其有效的文件扩展名。 |