Named Module Directory

What’s a named module directory?

Named module directories are optional module directories located in a modules directory. You can create as many named module directories as you need.

Example 1. Named module directories
📒 repository
  📂 docs (1)
    📄 antora.yml (2)
    📂 modules (3)
      📂 bears (4)
        📂 pages (5)
          📄 page-source-file.adoc (6)
        📄 nav.adoc (7)
      📂 get-started (8)
        📂 pages
          📄 page-source-file.adoc
1 Content source root
2 Required antora.yml file
3 Required modules directory
4 A module directory named bears
5 pages family directory
6 A source file for a page
7 A navigation file
8 A module directory named get-started

A named module directory must contain at least one family directory with at least one source file. A named module directory can also contain an optional navigation file.

Antora uses a module’s directory name to create a module’s name. A module name is used for source-to-source referencing and as a URL segment for the publishable resources that belong to the module. Therefore, the name of the module directory:

  • Should be accessible to content writers

  • Can’t contain characters that aren’t permitted in AsciiDoc macros and directives

  • Shouldn’t contain characters that inhibit web server portability, search engine optimization, or the best practices of your site’s search solution

  • Should meet your site’s accessibility requirements

For the reasons listed above, it’s important to carefully consider what you name your named module directories. See Recommendations for Module Directory Names to learn about the prohibited characters and recommended practices.

What’s a named module?

Source files in each named module directory become part of a named module in a component version. The name of a module corresponds to the name of a module directory. For instance, source files stored in the get-started module directory shown in Example 1 will be assigned to the module get-started.