Component and module list

Here, we explain the component:module combinations in the playbook for easy reference when you need to use a cross reference to a specific module. For more on using cross references, see the toolkit.

Antora uses the name field defined in the antora.yml file for each content repository as the component name. The module name is specified within the component repository. It’s typically ROOT unless specified otherwise. Any additional modules are outlined in the applicable repos below.

Format

xref:component:module:path/to/file.adoc[]

Example

xref:product-docs:ROOT:path/to/file.adoc[]

Actual reference
xref:product-docs:ROOT:Apps.adoc[] (1)
1 Output below.
Output

Breaking it down

So, if you want to reference another part of the documentation site, don’t use links. Instead, use the cross references as this help maintains compatibility in case a page moves or a version is updated.

Instructions

  1. Go to the playbook.

  2. Find the content you want to reference. For example purposes, let’s use the headless docs repo.

    content:
      sources:
    ...
      - url: https://git.magnolia-cms.com/scm/documentation/headless-docs.git (1)
        branches: [master]
    1 The headless docs reference in the antora site playbook.
  3. Take the reference and paste it in your browser. This takes you to the repository.

  4. Go to the antora.yml file in the repository and check the name field.

    name: headless (1)
    title: Headless Documentation
    version: master
    nav:
     - modules/ROOT/nav.adoc
    
    asciidoc:
      attributes:
    ...
    1 The component name.
  5. Now, you know how to reference the headless docs from another content repository. Check it out. By clicking the output below, you’ll go to the headless docs from our current spot in the dx-core docs.

    Asciidoc
    xref:headless:ROOT:spa-development.adoc[]
Feedback