@antora/html-single-extension
v1.0.0-beta.18
Published
An Antora extension that uses Assembler to merge pages into assembly files, export them to standalone HTML documents, and publish them with the site.
Readme
Antora HTML Single Extension
The Antora HTML Single 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 standalone HTML documents.
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 standalone HTML documents using Asciidoctor.js (or the specified command). Finally, Assembler adds those HTML documents 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/html-single-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 (MPL-2.0).
