Deploying Antora on Read the Docs

Antora is a static site generator for creating documentation sites from AsciiDoc content.

Minimal configuration is required to build an existing Antora project on Read the Docs.

.readthedocs.yaml

 version: 2

 build:
     os: ubuntu-lts-latest
     tools:
         nodejs: latest
     jobs:
       install:
         - npm i -g @antora/cli@3.1 @antora/site-generator@3.1
       build:
         html:
           - antora --fetch antora-playbook.yml --to-dir $READTHEDOCS_OUTPUT/html

Getting Started

If you have an existing Antora project you want to host on Read the Docs, check out our 增添文件專案 guide.
If you're new to Antora, check out the official Getting Started with Antora guide.

Example Repository and Demo

範例儲存庫: https://github.com/readthedocs/test-builds/tree/antora
Demo: https://test-builds.readthedocs.io/en/antora/

延伸閱讀

Antora documentation