页面目录和文件

页面家族目录

模块目录可以包含一个名为pages家族目录pages目录可以包含子目录。 只应将扩展名为.adoc的AsciiDoc源文件存储在pages目录及其子目录中,因为Antora在运行时会对页面文件应用预设行为。

📂 模块
  📂 命名模块 (1)
    📂 页面 (2)
      📄 页面源文件.adoc (3)
      📂 页面子目录 (4)
        📄 页面源文件.adoc
  📂 根 (5)
    📂 页面 (6)
      📄 页面源文件.adoc
    📄 导航.adoc
1 一个命名的模块目录。
2 一个pages家族目录。 存储在pages中的源文件被分类为页面。
3 使用AsciiDoc语法标记的页面文件,并保存为有效的.adoc文件扩展名。
4 pages中的子目录。 存储在pages目录的子目录中的源文件被分类为页面。
5 一个根模块目录。
6 一个pages家族目录。

pages目录是可选的。 也就是说,如果一个模块没有任何页面文件,就不要在模块中创建pages目录。 如果设置了pages目录,则pages目录或pages的子目录必须至少包含一个AsciiDoc源文件。

页面文件

Antora将存储在pages目录中的源文件分类为页面。 页面被构造为使用AsciiDoc语法标记的具有标题的单独文档,并保存为.adoc文件扩展名。 使用页面的资源ID,您可以从站点中的其他页面、资源或导航文件中交叉引用页面,或者将页面包含到站点中的其他页面或资源中。

页面文件是可发布资源,除非标记为隐藏或未发布。 这意味着Antora会自动将每个页面转换为HTML,并将其作为站点中的单独页面发布,即使该页面没有被其他资源或导航文件引用。 Antora在构建页面的URL时使用pages相对目录路径(如果存在)、页面的文件名和指定的HTML扩展样式。