Antora Documentation

The Static Site Generator for Tech Writers

This site hosts the technical documentation for Antora. Antora makes it easy for tech writers to create documentation and publish it to the web. As a tech writer, you focus on authoring content in AsciiDoc, Antora’s content markup language. You organize those files into a standard project structure and store them in one or more content (git) repositories. Antora picks up your content from there and transforms it into a website. That’s all there is to it!

Manage docs as code

With Antora, you manage docs as code. That means your documentation process benefits from the same practices used to produce successful software.

Some of these practices include:

  • Storing content in a version control system.

  • Separating content, configuration, and presentation.

  • Leveraging automation for compilation, validation, verification, and publishing.

  • Reusing shared materials (DRY).

Antora helps you incorporate these practices into your documentation workflow. As a result, your documentation is much easier to manage, maintain, and enhance.

Where to begin

If you’re just beginning your journey with Antora, you’ll probably want to know how Antora can help you. When you are familiar with the basic concepts, you can try out Antora using the Antora quickstart guide.

If you’re ready to set up a new documentation project, or you want to migrate an existing project to Antora, start by organizing your documentation files into the project structure Antora expects. You’ll then need to create a playbook to tell Antora where to find the documentation and UI to use for your site.

If you already have a documentation component set up, and you’re ready to create your first site, check that you’ve met Antora’s system requirements, then install Antora, and finally generate your site using the antora command.

If you want to jump into writing, learn how to use the AsciiDoc syntax to create documentation pages. You may find the IntelliJ AsciiDoc Plugin to be an author’s best friend. Not only does it assist with writing and previewing AsciiDoc content, it also provides state of the art tooling for creating and validating Antora configuration and resource references.

If you want to dive deeper into the details of the site generator pipeline, check out how Antora works.

We hope you find making documentation sites with Antora enjoyable and rewarding. Happy writing!