PDF Extension
The Antora PDF extension is an exporter extension for Assembler that handles converting content prepared by Assembler to the PDF format using Asciidoctor PDF. The Antora PDF extension is the official extension for exporting content in an Antora site to PDF.
Summary
- package name
-
@antora/pdf-extension
- require name
-
@antora/pdf-extension
- backend
-
pdf
- extname
-
.pdf
- mediaType
-
application/pdf
- default command
-
asciidoctor-pdf (prefixed with
bundle execif Gemfile.lock is present)
Description
The Antora PDF extension is based on Antora Assembler. It provides the converter metadata and convert function that Assembler uses to export content. The rest is handled by Assembler itself.
Assembler constructs the content of assembly files from pages per component version using the navigation as a model. Using the converter provided by this extension, it then iterates over those assembly files and converts them to PDF using Asciidoctor PDF (or the specified command). Finally, it adds those PDFs to the content catalog as exports, which Antora then publishes alongside the other files in the site.