Antora Binary Files Extension Pack

A group of Antora extensions that manage binary files in an Antora site to reduce memory use and minimize network and storage overhead when publishing the site.

Overview

This pack of extensions is intended to reduce the impact of working with large, binary files in your Antora site. These extensions help to reduce the impact of large files on the publishing time and storage requirements for your Antora site. On the one hand, it provides support for git lfs, both on the retrieval side and the publishing side. The pack also provides an extension for converting .docx to .pdf attachments at build time.

This package depends on and registers the following extensions from the Antora Binary Files Extension Suite:

• @opendevise/antora-git-lfs-extension
• @opendevise/antora-office-to-pdf-extension
• @opendevise/antora-object-storage-extension

The pack ensures these extensions are registered in the proper order.

Usage

First, refer to the usage for each extension in the pack to learn more about what it does.

$ npx --package antora --package @opendevise/antora-binary-files-extension-pack \
  --extension @opendevise/antora-binary-files-extension-pack antora-playbook.yml

Configuration

The configuration for this pack is passed down to each extension based on an extension key. Those keys are as follows:

• @opendevise/antora-git-lfs-extension
  git_lfs
• @opendevise/antora-office-to-pdf-extension
  office_to_pdf
• @opendevise/antora-object-storage-extension
  object_storage

For example, you can configure the extensions for the office-to-pdf-extension as follows:

antora:
  extensions:
  - package: '@opendevise/antora-binary-files-extension-pack'
    office_to_pdf:
      extensions: ['.doc', '.docx']

Refer to the usage for each extension in the pack to learn what configuration keys is accepts.

Copyright and License

Copyright (C) 2025-present OpenDevise Inc. and the Antora Project.

Use of this software is granted under the terms of the Mozilla Public License Version 2.0 (MPL-2.0).