Appendix: antora.yml Template

Appendix: antora.yml Template

Copy this into each spoke repo at docs/antora.yml. Replace the values.

# ============================================================================
# Component Descriptor — <Component Title>
# ============================================================================
# Location: docs/antora.yml (in the spoke repo root)
# Docs: https://docs.antora.org/antora/latest/component-version-descriptor/
# ============================================================================

name: infra-ops                         # URL-safe identifier (lowercase, hyphens)
title: Infrastructure Operations        # Human-readable title in sidebar
version: ~                              # Use ~ for versionless (recommended)
start_page: ROOT:index.adoc             # Default landing page
nav:
  - modules/ROOT/nav.adoc               # Navigation file

asciidoc:
  attributes:
    # ================================================================
    # ASCIIDOC SETTINGS (same for all spokes)
    # ================================================================
    icons: font                          # Font Awesome icons in admonitions
    source-highlighter: highlight.js     # Code block syntax highlighting
    experimental: ''                     # Enable keyboard macro (kbd:[])

    # ================================================================
    # COMPONENT-SPECIFIC ATTRIBUTES
    # ================================================================
    # Define all mutable values here — IPs, hostnames, VLANs, paths.
    # NEVER hardcode these in pages.
    #
    # Naming convention:
    #   <device>-ip         → sw-core-01-ip: 10.1.1.1
    #   <device>-hostname   → sw-core-01-hostname: sw-core-01.corp.example.com
    #   vlan-<name>         → vlan-data: 20
    #   port-<service>      → port-radius: 1812
    #   <path>-dir          → cert-dir: /etc/ssl/certs
    # ================================================================

    domain: corp.example.com

    # Network devices
    sw-core-01-ip: 10.1.1.1
    sw-core-02-ip: 10.1.1.2

    # Servers
    ise-01-ip: 10.1.10.20
    ise-02-ip: 10.1.10.21

    # VLANs
    vlan-mgmt: 10
    vlan-data: 20
    vlan-voice: 30

    # Ports
    port-radius: 1812
    port-tacacs: 49