Antora // Docs
Projects
Core
Repository Issue Tracker
Default UI
Repository Issue Tracker
Contributing
Tooling
Build Automation
Docker Image OCI Maven Plugin Java Gradle Plugin Java
Authoring / Preview
AsciiDoc Plugin IntelliJ
Community
Chat Zulip News Twitter Code of Conduct

Antora

    • What’s New in Antora 3.1
      • Asciidoctor Upgrade Notes
    • How Antora Can Help
    • How Antora Works
    • Install and Run Antora Quickstart
  • Get Antora
    • Linux Requirements
    • macOS Requirements
    • Windows Requirements
    • Install Antora
    • Upgrade Antora
    • Supported Platforms
  • Set Up Content Sources
    • How to Organize Your Content Files
    • Repositories and Content Source Roots
    • Content Source Versioning Methods
    • Standard File and Directory Set
    • Symlinks
    • Module Directories and Modules
      • ROOT Module Directory
      • Named Module Directory
      • Recommendations for Module Directory Names
      • Module Segment in Page URLs
    • Family Directories and Families
      • Pages Directory and Files
      • Partials Directory and Files
      • Examples Directory and Files
      • Images Directory and Files
      • Attachments Directory and Files
  • Configure Component Versions
    • What’s a Component Version?
    • What’s antora.yml?
    • Define a Component Version
    • Name Key
    • Version Key
    • Customize the Title
    • Customize the Display Version
    • Identify a Prerelease Version
    • Define a Component with No Version
    • Assign Attributes to a Component Version
    • Choose a Start Page
    • Assign Navigation Files to a Component Version
    • Version Facets
    • How Component Versions are Sorted
    • Distributed Component Versions
  • Resources and Resource IDs
    • Resource ID Coordinates
  • Pages
    • Set Up a Standard Page
    • Add a Title and Metadata
    • AsciiDoc Attributes in Antora
      • Define and Modify Attributes
      • Page Attributes
      • Intrinsic Attributes
    • Create a Start Page
    • Xref Macros and Page Links
      • Create Page Links
      • Page Link Text
    • Customize reftext and navtitle
    • Set Up URL Redirects with page-aliases
    • Assign UI Templates with page-layout
    • Include a Page
      • Unset page-partial Globally
  • Images
    • Add Block Images
    • Add Inline Images
    • Image Resource ID Examples
    • Resource Links From Images
  • Partials
    • Include a Partial
  • Examples
    • Include an Example
    • Attachments
  • AsciiDoc Primer
    • Document Header
    • Sections
    • Text and Punctuation Styles
      • Bold
      • Italic
      • Monospace
      • Highlight
      • Quote Marks and Apostrophes
      • Special Characters and Symbols
      • Subscript and Superscript
    • Internal Xrefs
    • URLs
    • Lists
      • Bullet and Numbered Lists
      • Description Lists
      • Checklists
    • Embed a Video
    • UI Macros
    • Source Blocks
    • Admonitions
    • Examples
    • Sidebars
    • Comments
  • Navigation
    • Navigation Assembly
    • Navigation Files and Lists
      • Create a Navigation File with One List
      • Create a Navigation File with Multiple Lists
    • Page Xrefs and Link Text
    • Attachment Xrefs and Link Text
    • Add Links to External Sites
    • Format List Content
    • Navigation File Locations
    • Compose Navigation Files
    • Register Navigation Files
  • Configure Your Site
    • Antora Playbook Introduction
    • Set Up a Playbook
    • Site Keys
      • Site URL
      • Site Title
      • Site Start Page
      • Robots
      • Account and API Keys
    • Content Keys
      • URLs for Content Sources
        • Private Repository Authentication
      • Branches
      • Worktrees
      • Tags
      • Single Start Path
      • Multiple Start Paths
      • Fallback Version
      • Edit URL
      • Refname Matching in Content Sources
    • Git Keys
      • Git Repository URL Suffix
      • Git Fetch Concurrency Limit
      • Git Read Concurrency Limit
      • Git Credentials Path and Contents
      • Git Plugins
    • AsciiDoc Keys
      • Assign Attributes to a Site
      • Asciidoctor Extensions
      • File and Line Number Information
    • UI Keys
      • UI Bundle URL
      • Supplemental UI
      • UI Output Directory
      • Default Layout for Pages
    • URLs Keys
      • HTML Extension Styles
      • Latest Version Segment
      • Latest Prerelease Version Segment
      • Latest Version Segment Strategy
      • Redirect Facility Key
    • Output Keys
      • Output Directory
      • Archive Provider
      • Filesystem Provider
      • Custom Provider
    • Runtime Keys
      • Log Keys
        • Log Severity Level
        • Log Failure Level
        • Log Format
        • Log Destination
      • Fetch Updates
      • Cache Directory
    • Network Keys
      • Network Proxy
    • Use Author Mode
    • Use an Existing Playbook Project
    • Environment Variables
  • Generate Your Site
    • Run Antora
    • Preview Your Site
    • Antora CLI Commands
      • CLI Options
      • CLI Primer
    • Configure Antora’s Cache
    • Run Antora in a Container
  • Publish Your Site
    • How Antora Builds URLs
    • Add a 404 Error Page
    • Automatic Sitemap
    • Publish to GitHub Pages
    • Publish to GitLab Pages
  • Extend Antora
    • Antora Extensions
      • Define an Extension
      • Register an Extension
      • Add Event Listeners
      • Use Context Variables
      • Configure an Extension
      • Enable an Extension
      • Extension Helpers
      • Class-Based Extension
      • Asynchronous Listeners
      • Replace Generator Functions
      • Extension Tutorial
      • Generator Events Reference
      • GeneratorContext API Reference
      • Extension Use Cases
    • Antora Components
    • Get Help
    • Security Bulletins
  • Project Governance
    • Release Schedule
    • Copyright and License
    • Land Acknowledgement
Antora 3.1
  • Antora
    • 3.1
    • 3.0
  • Antora Assembler
    • 1.0.0-beta.3
  • Antora Collector Extension
    • 1.0
  • Antora Default UI
  • Antora Maven Plugin
    • 1.0.0-alpha.5
  • Gradle Antora Plugin
    • 1.0
  • Antora
  • Project Governance
  • Copyright and License
3.1 3.0
Edit this Page

Antora Copyright and License

Copyright

Copyright © 2017-present OpenDevise Inc. and the individual contributors to Antora.

License

Use of Antora is granted under the terms of the Mozilla Public License Version 2.0 (MPL-2.0).

Trademarks

AsciiDoc® and AsciiDoc Language™ are trademarks of the Eclipse Foundation, Inc.

Release Schedule Land Acknowledgement

Copyright © OpenDevise Inc. and individual contributors to Antora. Chat powered by Zulip. Site deploys by Netlify.

Except where otherwise noted, docs.antora.org, Antora, and the Antora UI, are licensed under the Mozilla Public License Version 2.0 (MPL-2.0).

AsciiDoc® is a trademark of the Eclipse Foundation, Inc.