Configure Assembler
When you configure Assembler, you’re configuring both the assembly process itself and the exporter. The optional Assembler configuration is defined in a file named antora-assembler.yml next to the Antora playbook file by default. An alternate file may be specified when registering the extension.
antora-assembler.yml
The Assembler configuration file is an optional YAML file that defines settings and AsciiDoc attributes that are only applied to exports. By default, the file is named antora-assembler.yml adjacent to your Antora playbook file in the playbook project.
📒 repository 📄 antora-assembler.yml 📄 antora-playbook.yml
If you’re using Assembler to export to multiple formats, you should use a configuration file per format. For example, when exporting to PDF and EPUB, you might name the configuration files antora-assembler-pdf.yml and antora-assembler-epub.yml.
📒 repository 📄 antora-assembler-epub.yml 📄 antora-assembler-pdf.yml 📄 antora-playbook.yml
You can specify an alternate configuration file using the config_file key (or multiple using the config_files key) when registering the extension.
If Assembler doesn’t find a configuration file at the path specified (or the default path when no configuration file is specified), Assembler will use the default configuration. No error is thrown if the configuration file is absent. Assembler will proceed with the built-in default config.
enabled key
Even if an exporter extension is registered with the Antora runtime, you can quickly deactivate (that instance of) Assembler in the Assembler configuration by setting the top-level enabled key to false.
This key accepts a Boolean value.
By default, the implicit value of this key is true.
enabled: falseThis key offers a quick and convenient way to deactivate Assembler without having to modify the Antora playbook or the CLI options.
Going further
You can switch to programmatic configuration of Assembler if you want even more control over how Assembler works and what navigation it uses.