@antora/pdf-extension/README.md

An Antora extension that uses Assembler to merge pages into assembly files, export them to the PDF format, and publishe them with the site.

# Antora PDF Extension

The Antora PDF extension is an Antora extension and exporter for Assembler.
It configures and invokes Assembler and provides the converter function and metadata Assembler uses to export content to the PDF format.
This extension is the official extension for exporting content in an Antora site to PDF.

This extension first delegates to Assembler, passing in the converter metadata, to construct assembly files from pages per component version using the navigation as a model.
Assembler then iterates over those assembly files and, using the converter provided by this extension, converts them to PDF using Asciidoctor PDF (or the specified command).
Finally, Assembler adds those PDFs to the content catalog as exports, which Antora publishes alongside the other files in the site.

## Usage

Once this package is installed in the playbook project, register it in the Antora playbook as follows:

**antora-playbook.yml**

```yaml
antora:
  extensions:
  - '@antora/pdf-extension'
# ...
```

You can configure the behavior of the extension using the optional _antora-assembler.yml_ file.

## Copyright and License

Copyright (C) 2022-present by OpenDevise Inc. and the individual contributors of this project.

Use of this software is granted under the terms of the [Mozilla Public License Version 2.0](https://www.mozilla.org/en-US/MPL/2.0/) (MPL-2.0).