@antora/pdf-extension 1.0.0-alpha.1

package/README.md

@@ -0,0 +1,30 @@
+# Antora PDF Extension
+
+The Antora PDF Extension is the official extension for producing PDFs of an Antora site.
+Specifically, it generates and publishes PDFs of aggregate pages in the site.
+
+This extension is based on Antora Assembler.
+It calls Assembler to construct aggregate AsciiDoc documents from pages based on the navigation tree per component version.
+It then iterates over those aggregate documents and converts them to PDF using Asciidoctor PDF or the specified command.
+Finally, it pushes those PDFs into the site catalog so they are published as attachments 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).

package/lib/convert-document-to-pdf.js

@@ -0,0 +1,43 @@
+'use strict'
+
+const { runCommand } = (() => {
+  try {
+    return require('@antora/assembler')
+  } catch {
+    return require('../../assembler')
+  }
+})()
+const ospath = require('path')
+
+// Q: how can we simplify this to avoid redundant code?
+// Q: rename to convertDocumentToPDF?
+function convertDocumentToPdf (doc, buildConfig) {
+  const {
+    asciidoc: { attributes: baseAttributes } = { attributes: {} },
+    contents: input,
+    src: { component, version, basename, extname: docfilesuffix },
+  } = doc
+  const { command = 'asciidoctor-pdf', cwd, dir } = buildConfig
+  const docfile = `${version}@${component}::pdf$${basename}`
+  const docname = basename.substr(0, basename.length - docfilesuffix.length)
+  const convertAttributes = Object.assign({}, baseAttributes, {
+    docfile,
+    docfilesuffix,
+    'docname@': docname,
+    imagesdir: dir,
+  })
+  Object.assign(doc, { contents: null, extname: '.pdf', mediaType: 'application/pdf' })
+  const argv = Object.entries(convertAttributes).reduce(
+    (accum, [name, val]) =>
+      accum.push('-a', val ? `${name}=${val}` : val === '' ? name : `!${name}${val === false ? '=@' : ''}`) && accum,
+    []
+  )
+  const output = ospath.join(dir, doc.path)
+  argv.push('-o', output)
+  // Q: should runCommand accept outputFlag and automatically append to argv?
+  return runCommand(command, argv, { cwd, input, output }).then((contents) =>
+    Object.assign(doc, { contents, out: { path: doc.path } })
+  )
+}
+
+module.exports = convertDocumentToPdf

package/lib/index.js

@@ -0,0 +1,26 @@
+'use strict'
+
+const convertDocumentToPdf = require('./convert-document-to-pdf')
+const { assembleContent } = (() => {
+  try {
+    return require('@antora/assembler')
+  } catch {
+    return require('../../assembler')
+  }
+})()
+
+module.exports.register = function () {
+  //this.on('beforeProcess', ({ asciidocConfig }) => {
+  //  asciidocConfig.keepSource = true
+  //})
+  this.on('contentClassified', ({ contentCatalog }) => {
+    contentCatalog.getPages((page) => {
+      if (!page.out) return
+      page.src.contents = page.contents
+      page.src = new Proxy(page.src, { deleteProperty: (o, p) => (p === 'contents' ? true : delete o[p]) })
+    })
+  })
+  this.on('beforePublish', ({ playbook, contentCatalog, siteCatalog }) =>
+    assembleContent.call(this, playbook, contentCatalog, convertDocumentToPdf, { siteCatalog })
+  )
+}

package/package.json

@@ -0,0 +1,45 @@
+{
+  "name": "@antora/pdf-extension",
+  "version": "1.0.0-alpha.1",
+  "description": "An Antora extension that assembles content pages into PDF files by version and publishes them with the site.",
+  "license": "MPL-2.0",
+  "author": "OpenDevise Inc. (https://opendevise.com)",
+  "contributors": [
+    "Dan Allen <dan@opendevise.com>",
+    "Sarah White <sarah@opendevise.com>"
+  ],
+  "homepage": "https://antora.org",
+  "repository": "gitlab:antora/antora-assembler",
+  "bugs": {
+    "url": "https://gitlab.com/antora/antora-assembler/issues"
+  },
+  "scripts": {
+    "prepublishOnly": "node $npm_config_local_prefix/npm/prepublishOnly.js",
+    "postpublish": "node $npm_config_local_prefix/npm/postpublish.js"
+  },
+  "main": "lib/index.js",
+  "exports": {
+    ".": "./lib/index.js"
+  },
+  "dependencies": {
+    "@antora/assembler": "1.0.0-alpha.1"
+  },
+  "engines": {
+    "node": ">=16.0.0"
+  },
+  "files": [
+    "lib/"
+  ],
+  "keywords": [
+    "antora",
+    "antora-extension",
+    "asciidoc",
+    "asciidoctor",
+    "pdf",
+    "generator",
+    "documentation"
+  ],
+  "publishConfig": {
+    "access": "public"
+  }
+}