命名模块目录
什么是命名模块目录
命名模块目录是位于模块(modules)目录中的可选模块目录。您可以根据需要创建任意数量的命名模块目录。
Example 1. Example 1. Named module directories
📒 repository
📂 docs (1)
📄 antora.yml (2)
📂 modules (3)
📂 bears (4)
📂 pagesAlian (5)
📄 page-source-file.adoc (6)
📄 nav.adoc (7)
📂 get-started (8)
📂 pagesAlian
📄 page-source-file.adoc| 1 | 内容源根 |
| 2 | 必需的 antora.yml 文件 |
| 3 | 必需的模块目录 |
| 4 | 一个名为 bears 的模块目录 |
| 5 | 页面家庭目录 |
| 6 | 页面的源文件 |
| 7 | 导航文件 |
| 8 | 一个名为 get-started 的模块目录 |
命名模块目录必须包含至少一个具有至少一个源文件的族目录。命名模块目录还可以包含可选的导航文件。
Antora 使用模块的目录名来创建模块的名称。模块名用于源到源的引用，并作为属于该模块的可发布资源的 URL 段。因此，模块目录的名称：
-
内容作者是否可以访问
-
不能包含在 AsciiDoc 宏和指令中不允许的字符
-
不应该包含限制 web 服务器可移植性、搜索引擎优化或网站搜索解决方案最佳实践的字符
-
应该满足网站的可访问性要求吗
由于上面列出的原因，仔细考虑如何命名模块目录是很重要的。请参阅模块目录名推荐，了解禁用字符和推荐的做法。