命名模块目录
什么是命名模块目录?
命名模块目录是位于模块目录中的可选模块目录。您可以根据需要创建多个命名模块目录。
示例1. 命名模块目录
📒 仓库 📂 文档 (1) 📄 antora.yml (2) 📂 模块 (3) 📂 熊 (4) 📂 页面 (5) 📄 页面源文件.adoc (6) 📄 导航.adoc (7) 📂 入门 (8) 📂 页面 📄 页面源文件.adoc
1 | 内容源根目录 |
2 | 必需的antora.yml文件 |
3 | 必需的模块目录 |
4 | 名为熊的模块目录 |
5 | 页面家族目录 |
6 | 页面的源文件 |
7 | 导航文件 |
8 | 名为入门的模块目录 |
命名模块目录必须至少包含一个家族目录,其中至少包含一个源文件。命名模块目录还可以包含一个可选的导航文件。
Antora使用模块目录的名称来创建模块名称。模块名称用于源到源的引用以及作为属于模块的可发布资源的URL段。因此,模块目录的名称应:
-
应该对内容撰写者可访问
-
不能包含AsciiDoc宏和指令中不允许的字符
-
不应包含阻碍Web服务器可移植性、搜索引擎优化或站点搜索解决方案最佳实践的字符
-
应符合站点的可访问性要求
出于上述原因,仔细考虑您命名的命名模块目录是很重要的。请参阅模块目录名称建议,了解被禁止的字符和推荐做法。
什么是命名模块?
每个命名模块目录中的源文件将成为组件版本中的一个命名模块的一部分。模块的名称对应于模块目录的名称。例如,在示例1中显示的存储在入门模块目录中的源文件将被分配给模块入门
。