🚀 Big News:Socket Has Acquired Secure Annex.Learn More →
Socket
Book a DemoSign in
Socket

@antora/pdf-extension

Package Overview
Dependencies
Maintainers
2
Versions
32
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

@antora/pdf-extension

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

latest
Source
npmnpm
Version
1.0.0-beta.20
Version published
Weekly downloads
6.2K
-7.25%
Maintainers
2
Weekly downloads
 
Created
Source

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

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

You can configure the behavior of the extension using the optional configuration file, named antora-assembler.yml by default. When using more than one exporter extension, you likely want to use a dedicated configuration file named according to the export filetype (e.g., antora-assembler-pdf.yml). The configuration file can be specified using the config_file key on the extension entry.

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 (MPL-2.0).

Keywords

antora

FAQs

Package last updated on 16 Mar 2026

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts