Documentation Generators

Antora – modular documentation site generator

Antora is a documentation site generator designed for projects that maintain their technical documentation in Git repositories. It uses AsciiDoc as its authoring format and provides a structured system for publishing documentation covering multiple components and product versions.

The application separates documentation content from the website’s presentation. Technical writers maintain individual pages in repositories, while Antora collects the selected content and assembles it into a unified website. A configuration file known as a playbook defines which sources should be included and how the final website should be generated.

Antora is particularly useful for organisations maintaining documentation across several related software projects. Its component and version model enables developers to organise extensive documentation collections without merging everything into a single repository. This approach also helps documentation follow the same review and version-control practices as the software it describes.

This is free and open source software.

Key Features

  • Generates documentation websites from AsciiDoc source files.
  • Collects documentation content from multiple local or remote Git repositories.
  • Supports documentation components and versions defined by component descriptor files.
  • Can select content from particular Git branches, tags and repository paths.
  • Uses a playbook to configure documentation sources, website settings and output.
  • Generates navigation using component-specific navigation files.
  • Supports cross-references between pages, modules, components and versions.
  • Separates content from presentation through configurable user-interface bundles.
  • Automatically resolves resource identifiers to create links between documentation elements.
  • Supports Asciidoctor extensions for additional document processing.
  • Provides extension points for customising the content collection and publishing pipeline.
  • Cross-platform support – runs on Linux, macOS, and Windows.

Website: gitlab.com/antora/antora
Support:
Developer: OpenDevise Inc. and individual contributors
License: Mozilla Public License v2.0

Antora is written in JavaScript. Learn JavaScript with our recommended free books and free tutorials.


Related Software

Documentation Generators
JSDocAPI documentation generator for JavaScript
JavadocGenerate API documentation in HTML format
SphinxCreate intelligent and beautiful documentation for Python projects
phpDocumentorComplete documentation solution for PHP
DoxygenDocumentation system for C, C++, Java, Python and other languages
DocusaurusBuild, deploy and maintain documentation websites
mdBookCreate modern online books from Markdown files
YARDRuby documentation tool
StarlightDocumentation website framework
DoccoLiterate-programming-style documentation generator
Natural DocsDocumentation generator that supports 21 different languages
QuartoScientific and technical publishing system
AntoraModular documentation site generator
CryccoQuick and dirty documentation generator
ROBODocDocumentation tool similar to Javadoc

Read our verdict in the software roundup.


Best Free and Open Source Software Explore our carefully curated directory of recommended free and open source software, covering every major software category.

The directory forms part of our extensive collection of articles for Linux enthusiasts. It includes hundreds of detailed reviews, together with free and open source alternatives to proprietary software from companies such as Google, Microsoft, Apple, Adobe, IBM, Cisco, Oracle, and Autodesk.

LinuxLinks also covers interesting projects worth exploring, Linux-compatible hardware, free programming books and tutorials, and much more.

Know a useful free and open source Linux application that we haven’t covered? Tell us about it using our submission form.
Subscribe

Please read our Comment Policy before commenting.

Notify of
guest
0 Comments
Oldest
Newest Most Voted