Images Directory and Files

Images family directory

A module directory can contain an optional family directory named images.

📂 modules
  📂 ROOT (1)
    📂 images (2)
      📄 image-source-file.ext (3)
    📁 pages
    📄 nav.adoc
  📂 named-module (4)
    📁 examples
    📂 images (5)
      📄 image-source-file.ext
      📂 subdirectory-of-images (6)
        📄 image-source-file.ext
    📁 pages

1	A ROOT module directory.
2	An images family directory. Antora classifies source files stored in an images directory as images.
3	An image source file.
4	A named module directory.
5	An images family directory.
6	A subdirectory in images. Source files stored in subdirectories of a images directory are classified as images.

Antora applies preset behavior to the source files stored in an images directory when it generates a site.

Image files

Images are resources, such as photographs, diagrams, and screenshots. The source files for images are stored in an images family directory. Antora supports the PNG, JPG, SVG, and GIF (static and animated) image file formats.

Regardless of the component version the image belongs to, the image can be embedded into a page or partial using the image’s resource ID and an AsciiDoc block image macro or inline image macro.

Antora automatically publishes each image file, except when the image file is marked as hidden or it’s missing a file extension. Antora uses the family segment and relative path segment of the image file when building the URL for an image.

Assets

A module directory can also contain a directory named assets. This is an alternate location, recognized by Antora, where the attachments and images family directories can be placed.

📒 repository
  📄 antora.yml
  📂 modules
    📂 ROOT
      📂 assets
        📂 attachments
          📄 attachment-source-file.ext
        📂 images
          📄 image-source-file.ext
      📁 pages
      📄 nav.adoc

You don’t need to set the path to these predefined directories in the header of your pages. This is managed automatically by Antora.