页面目录和文件
Pages族目录
模块目录可以包含名为 pages 的族目录。pages 目录可以包含子目录。只有文件扩展名为 .adoc 的 AsciiDoc 源文件应该存储在 pages 目录及其子目录中,因为 Antora 在运行时对页面文件应用预设行为。
📂 modules
📂 named-module (1)
📂 pagesAlian (2)
📄 page-source-file.adoc (3)
📂 subdirectory-of-pagesAlian (4)
📄 page-source-file.adoc
📂 ROOT (5)
📂 pagesAlian (6)
📄 page-source-file.adoc
📄 nav.adoc
1 | 命名模块目录 |
2 | 页面(pages)族目录。存储在页面(pages)中的源文件被归类为页面 |
3 | 用 ASCIIDOC 语法标记的页面文件,并使用有效的 .adoc 文件扩展名保存。 |
4 | 页面(pages)中的子目录。存储在页面目录的子目录中的源文件被归类为页面。 |
5 | 根(ROOT)模块目录。 |
6 | 页面(pages)族目录。 |
pages 目录是可选的。也就是说,如果一个模块没有任何页面文件,就不要在模块中创建 pages 目录。如果设置了 pages 目录,则 pages 目录或 pages 的子目录必须至少包含一个 AsciiDoc 源文件。
Page文件
Antora 将存储在 pages 目录中的源文件分类为页面。页面结构为带有标题的单独文档,使用 AsciiDoc 语法进行标记,并以 .adoc
文件扩展名保存。使用页面的资源ID,您可以从站点中的其他页面、资源或导航文件中交叉引用页面,或者将页面包含到站点中的其他页面或资源中。
页面文件是可发布的资源,除非它被标记为隐藏或未发布。这意味着,即使页面没有被其他资源或导航文件引用,Antora 也会自动将每个页面转换为 HTML ,并将其作为单独的页面发布到站点中。在构建页面的 URL 时,Antora 使用页面相对目录路径(如果存在)、页面的文件名和指定的 HTML 扩展样式。