@antora/assembler 1.0.0-alpha.6 → 1.0.0-alpha.8

package/lib/assemble-content.js

@@ -3,6 +3,7 @@
 const loadConfig = require('./load-config')
 const produceAggregateDocuments = require('./produce-aggregate-documents')
 const PromiseQueue = require('./util/promise-queue')
+const runCommand = require('./util/run-command')
 
 async function assembleContent (playbook, contentCatalog, converter, { siteCatalog, configSource }) {
   // Q: could we get ContentCatalog#getComponentVersionStartPage() in Antora core?
@@ -23,7 +24,7 @@ async function assembleContent (playbook, contentCatalog, converter, { siteCatal
   // TODO: pass more information to converter so it doesn't have to compute internal stuff
   // Q: don't we need to pass in the combined/resolved AsciiDoc attributes per file or component version?
   return new PromiseQueue({ concurrency: buildConfig.processLimit })
-    .add(aggregateDocuments.map((doc) => () => converter.call(this, doc, buildConfig)))
+    .add(aggregateDocuments.map((doc) => () => converter.call(this, doc, buildConfig, runCommand)))
     .toPromise()
     .then((files) => {
       if (buildConfig.publish && siteCatalog) siteCatalog.addFiles(files)
@@ -31,7 +32,7 @@ async function assembleContent (playbook, contentCatalog, converter, { siteCatal
     })
 }
 
-// TODO: if no workspace dir is defined; we shouldn't continue
+// TODO: if no workspace dir is defined, we shouldn't continue
 function prepareWorkspace (publishFiles, aggregateDocuments, contentCatalog, buildConfig) {
   const { dir, clean, keepAggregateSource } = buildConfig
   const files = contentCatalog.findBy({ family: 'image' }).filter(({ out }) => out?.assembled)

package/lib/filter-component-versions.js

@@ -21,11 +21,11 @@ function compilePatterns (patterns) {
   if (patterns[0].charAt() === '!') patterns = ['**', ...patterns]
   return patterns.map((pattern) => {
     const negated = pattern.charAt() === '!'
-    if (negated) pattern = pattern.substr(1)
+    if (negated) pattern = pattern.slice(1)
     let version
     const separatorIdx = pattern.search(VERSION_SEPARATOR_RX)
     if (~separatorIdx) {
-      pattern = (version = true) && `${pattern.substr(0, separatorIdx)}%${pattern.substr(separatorIdx + 1) || '*'}`
+      pattern = (version = true) && `${pattern.slice(0, separatorIdx)}%${pattern.slice(separatorIdx + 1) || '*'}`
     }
     return Object.assign(makePicomatchRx(pattern, PICOMATCH_OPTS), {
       globstar: pattern === '**',

package/lib/load-config.js

@@ -1,8 +1,8 @@
 'use strict'
 
 const expandPath = require('@antora/expand-path-helper')
-const { promises: fsp } = require('fs')
-const os = require('os')
+const fsp = require('node:fs/promises')
+const os = require('node:os')
 const yaml = require('js-yaml')
 
 function loadConfig (playbook, configSource = './antora-assembler.yml') {
@@ -27,8 +27,9 @@ function loadConfig (playbook, configSource = './antora-assembler.yml') {
       config.asciidoc.attributes = asciidocAttrs = {}
     }
     if (!('doctype' in asciidocAttrs)) asciidocAttrs.doctype = 'book'
-    asciidocAttrs.revdate = new Date().toISOString().split('T')[0]
+    if (!('revdate' in asciidocAttrs)) asciidocAttrs.revdate = getLocalDate()
     asciidocAttrs['page-partial'] = null
+    asciidocAttrs['loader-assembler'] = ''
     if (config.componentVersions == null) {
       config.componentVersions = ['*']
     } else if (typeof config.componentVersions === 'string') {
@@ -46,7 +47,7 @@ function loadConfig (playbook, configSource = './antora-assembler.yml') {
     } else {
       build.dir = expandPath(build.dir || './build/assembler', { dot: playbook.dir })
     }
-    build.cwd = playbook.dir // use playbook.dir the purpose of finding and loading require scripts
+    build.cwd = playbook.dir // use playbook.dir for the purpose of finding and loading require scripts
     if (!('clean' in build) && 'output' in playbook) build.clean = playbook.output.clean
     if (!('publish' in build)) build.publish = true
     if (!build.processLimit) {
@@ -62,10 +63,14 @@ function camelCaseKeys (o, stopPaths = [], p) {
   const pathPrefix = p ? p + '.' : ''
   const accum = {}
   for (const [k, v] of Object.entries(o)) {
-    const camelKey = k.charAt() + k.substr(1).replace(/_([a-z])/g, (_, l) => l.toUpperCase())
+    const camelKey = k.charAt() + k.slice(1).replace(/_([a-z])/g, (_, l) => l.toUpperCase())
     accum[camelKey] = ~stopPaths.indexOf(pathPrefix + camelKey) ? v : camelCaseKeys(v, stopPaths, pathPrefix + camelKey)
   }
   return accum
 }
 
+function getLocalDate (now = new Date()) {
+  return new Date(now - now.getTimezoneOffset() * 60000).toISOString().split('T')[0]
+}
+
 module.exports = loadConfig

package/lib/produce-aggregate-document.js

@@ -1,7 +1,8 @@
 'use strict'
 
 const File = require('vinyl')
-const { posix: path } = require('path')
+const path = require('node:path/posix')
+const sanitize = require('./util/sanitize')
 
 function produceAggregateDocument (
   loadAsciiDoc,
@@ -16,7 +17,17 @@ function produceAggregateDocument (
 ) {
   const pagesInOutline = selectPagesInOutline(outline, pages)
   const navtitle = outline.content
-  const stem = generateStem(componentVersion, navtitle)
+  const templateFile = contentCatalog.addFile({
+    src: {
+      component: componentVersion.name,
+      version: componentVersion.version,
+      module: 'ROOT',
+      family: 'page',
+      relative: generateSlug(navtitle),
+    },
+  })
+  const path_ = `${templateFile.out.path}.adoc`
+  contentCatalog.removeFile(templateFile)
   const header = buildAsciiDocHeader(componentVersion, navtitle, doctype)
   const body = aggregateAsciiDoc(
     loadAsciiDoc,
@@ -29,29 +40,32 @@ function produceAggregateDocument (
     mutableAttributes,
     sectionMergeStrategy
   )
-  const relativeSrcPath = `${stem}.adoc`
   return new File({
+    aggregate: true,
     asciidoc: asciidocConfig,
     contents: Buffer.from([...header, ...body].join('\n') + '\n'),
     mediaType: 'text/asciidoc',
-    path: relativeSrcPath,
+    path: path_,
     src: {
       component: componentVersion.name,
       version: componentVersion.version,
-      basename: path.basename(relativeSrcPath),
-      stem,
+      basename: path.basename(path_),
+      stem: path.basename(path_, '.adoc'),
       extname: '.adoc',
     },
   })
 }
 
 function buildAsciiDocHeader (componentVersion, navtitle, doctype = 'book') {
-  const doctitle = navtitle === componentVersion.title ? navtitle : `${componentVersion.title}: ${navtitle}`
+  const [navtitlePlain, navtitleAsciiDoc] = sanitize(navtitle)
+  let doctitle = navtitleAsciiDoc
+  if (navtitlePlain !== componentVersion.title) doctitle = `${componentVersion.title}: ${doctitle}`
   const version = componentVersion.version === 'master' ? '' : componentVersion.version
   return [
     `= ${doctitle}`,
-    ...(version ? [`v${version}`] : []),
+    ...(version ? [`:revnumber: ${version}`] : []),
     ...(doctype === 'article' ? [] : [`:doctype: ${doctype}`]),
+    ':underscore: _',
     // Q: should we pass these via the CLI so they cannot be modified?
     `:page-component-name: ${componentVersion.name}`,
     `:page-component-version:${version ? ' ' + version : ''}`,
@@ -84,16 +98,24 @@ function aggregateAsciiDoc (
   asciidocConfig,
   mutableAttributes,
   sectionMergeStrategy,
+  lastComponentVersion = componentVersion,
   level = 0
 ) {
   const buffer = []
   // TODO: we could try to be smart about it and make sure the page with fragment is included at least once
   if (outlineEntry.hash) return buffer
   const { content: navtitle, items, unresolved, urlType, url } = outlineEntry
+  const [navtitlePlain, navtitleAsciiDoc, navtitlePass] = sanitize(navtitle)
+  const siteUrl = ((val) => {
+    if (!val || val === '/') return ''
+    return val.charAt(val.length - 1) === '/' ? val.slice(0, val.length - 1) : val
+  })(asciidocConfig.attributes['site-url'])
   // FIXME: ideally, resource ID would be stored in navigation so we can look up the page more efficiently
   let page = urlType === 'internal' && !unresolved ? pagesInOutline.get(url) : undefined
+  if (page && pagesInOutline.aggregated?.includes(page)) page = undefined
   if (page) {
     let contents = page.src.contents
+    if (contents == null) return buffer
     // NOTE: blank lines at top and bottom of document create mismatch when using line numbers to navigate source lines
     // IMPORTANT: this must not leave behind lines the parser will drop!
     // IDEA: another option is to capture initial lineno of reader and use as offset (but preseves those blank lines)
@@ -103,17 +125,36 @@ function aggregateAsciiDoc (
         .replace(/^(?:[ \t]*\r\n?|[ \t]*\n)+/, '')
         .trimRight()
     )
+    ;(pagesInOutline.aggregated ??= []).push(page)
     page = new page.constructor(Object.assign({}, page, { contents, mediaType: 'text/asciidoc' }))
-    const { module: module_, relative, origin } = page.src
+    const { component, version, module: module_, relative, origin } = page.src
     const doc = loadAsciiDoc(page, contentCatalog, asciidocConfig)
     const refs = doc.getCatalog().refs
     // NOTE: in Antora, docname is relative src path from module without file extension
     const docname = doc.getAttribute('docname')
-    //const idprefix = `${module_ === 'ROOT' ? '' : module_ + ':'}${docname}//`
-    const idprefix = `${module_ === 'ROOT' ? '' : module_ + ':'}${docname.replace(/[/]/g, '::')}:::`
-    //const idprefix = `${module_ === 'ROOT' ? '' : module_ + ':'}${docname.replace(/[/]/g, ':-:')}:--:`
+    const docnameForId = docname.replace(/[/]/g, '::').replace(/[.]/g, '-')
+    const scopeId = component !== componentVersion.name
+    const idprefix =
+      (scopeId ? component + ':' : '') +
+      (module_ === 'ROOT' ? (scopeId ? ':' : '') : module_ + ':') +
+      docnameForId +
+      ':::'
     buffer.push('')
     buffer.push(`:docname: ${docname}`)
+    if (component !== lastComponentVersion.name) {
+      const thisComponentVersion =
+        component === componentVersion.name && version === componentVersion.version
+          ? componentVersion
+          : contentCatalog.getComponentVersion(component, version)
+      if (thisComponentVersion) {
+        buffer.push(`:page-component-name: ${thisComponentVersion.name}`)
+        buffer.push(`:page-component-version:${thisComponentVersion.version ? ' ' + thisComponentVersion.version : ''}`)
+        buffer.push(':page-version: {page-component-version}')
+        buffer.push(`:page-component-display-version: ${thisComponentVersion.displayVersion}`)
+        buffer.push(`:page-component-title: ${thisComponentVersion.title}`)
+        lastComponentVersion = thisComponentVersion
+      }
+    }
     buffer.push(`:page-module: ${module_}`)
     buffer.push(`:page-relative-src-path: ${relative}`)
     //buffer.push(`:page-origin-type: ${origin.type}`)
@@ -125,7 +166,7 @@ function aggregateAsciiDoc (
     let enclosed
     // NOTE: if level is 0, doctitle has already been added and we're in the document header
     if (level) {
-      if (level === 1 && navtitle === componentVersion.title) {
+      if (level === 1 && navtitlePlain === componentVersion.title) {
         level--
       } else {
         let hlevel = level + 1
@@ -135,7 +176,7 @@ function aggregateAsciiDoc (
         } else {
           buffer.push(`[#${idprefix}]`)
         }
-        buffer.push(`${'='.repeat(hlevel)} ${navtitle}`)
+        buffer.push(`${'='.repeat(hlevel)} ${navtitleAsciiDoc}`)
       }
     } else {
       header.unshift(`[#${idprefix}]`)
@@ -167,10 +208,6 @@ function aggregateAsciiDoc (
       buffer.push(`${'='.repeat(hlevel)} ${overviewTitle}`)
       if (toggleSectids) buffer.push(':sectids:')
     }
-    const siteUrl = ((val) => {
-      if (!val || val === '/') return ''
-      return val.charAt(val.length - 1) === '/' ? val.substr(0, val.length - 1) : val
-    })(doc.getAttribute('site-url'))
     const lines = doc.getSourceLines()
     const ignoreLines = []
     // TODO: think more about when multipart is allowed; perhaps configurable
@@ -206,9 +243,23 @@ function aggregateAsciiDoc (
         for (let i = idx; i < block.lines.length + (delimited ? idx + 2 : idx); i++) ignoreLines.push(i)
       }
     })
+    let skipping
     for (let idx = 0, len = lines.length; idx < len; idx++) {
       if (~ignoreLines.indexOf(idx)) continue
       let line = lines[idx]
+      if (line.startsWith('//')) {
+        if (line[2] !== '/') continue
+        if (line.length > 3 && line === '/'.repeat(line.length)) {
+          if (skipping) {
+            if (line === skipping) skipping = undefined
+          } else {
+            skipping = line
+          }
+          continue
+        }
+      } else if (skipping) {
+        continue
+      }
       if (line.charAt() === ':' && /^:(?:leveloffset: .*|!leveloffset:|leveloffset!:)$/.test(line)) {
         if (lines[idx - 1] === '') lines[idx - 1] = undefined
         lines[idx] = undefined
@@ -233,8 +284,8 @@ function aggregateAsciiDoc (
           let pagePart, fragment, targetPage
           const hashIdx = target.indexOf('#')
           if (~hashIdx) {
-            pagePart = target.substr(0, hashIdx)
-            fragment = target.substr(hashIdx + 1)
+            pagePart = target.slice(0, hashIdx)
+            fragment = target.slice(hashIdx + 1)
             // TODO: for now, assume .adoc; in the future, consider other file extensions
             if (pagePart && !pagePart.endsWith('.adoc')) pagePart += '.adoc'
           } else if (target.endsWith('.adoc')) {
@@ -250,22 +301,29 @@ function aggregateAsciiDoc (
               : `<<${idprefix}${fragment}${text ? ',' + text.replace(/\\]/g, ']') : ''}>>`
           }
           if (~pagePart.indexOf('@') || /:.*:/.test(pagePart)) {
+            if (siteUrl && (targetPage = contentCatalog.resolvePage(pagePart, page.src)) && targetPage.out) {
+              text ||= targetPage.asciidoc?.xreftext || target
+              return `${siteUrl}${targetPage.pub.url}${fragment && '#' + fragment}[${text}]`
+            }
             // TODO: handle unresolved page better
-            return siteUrl && (targetPage = contentCatalog.resolvePage(pagePart, page.src))
-              ? `${siteUrl}${targetPage.pub.url}${fragment && '#' + fragment}[${text}]`
-              : m
+            return m
           } else if (pagePart.indexOf(':') < 0) {
             if (module_ !== 'ROOT') pagePart = `${module_}:${pagePart}`
           } else if (pagePart.startsWith('ROOT:')) {
-            pagePart = pagePart.substr(5)
+            pagePart = pagePart.slice(5)
           }
           if (!(targetPage = pagesInOutline.get(pagePart))) {
+            if (siteUrl && (targetPage = contentCatalog.resolvePage(pagePart, page.src)) && targetPage.out) {
+              text ||= targetPage.asciidoc?.xreftext || target
+              return `${siteUrl}${targetPage.pub.url}${fragment && '#' + fragment}[${text}]`
+            }
             // TODO: handle unresolved page better
-            return siteUrl && (targetPage = contentCatalog.resolvePage(target, page.src))
-              ? `${siteUrl}${targetPage.pub.url}${fragment && '#' + fragment}[${text}]`
-              : m
+            return m
           }
-          pagePart = pagePart.replace(/[/]/g, '::').replace(/\.adoc$/, '')
+          pagePart = pagePart
+            .replace(/[/]/g, '::')
+            .replace(/\.adoc$/, '')
+            .replace(/[.]/g, '-')
           const refid = `${pagePart}:::${fragment}`
           return `<<${refid}${text && text !== targetPage.title ? ',' + text.replace(/\\]/g, ']') : ''}>>`
         })
@@ -281,7 +339,10 @@ function aggregateAsciiDoc (
               family: 'attachment',
               relative,
             })
-          return attachment ? `${siteUrl}${attachment.pub.url}[${text}]` : m
+          // TODO: handle unresolved attachment page
+          return attachment && attachment.out
+            ? `${siteUrl}${attachment.pub.url.replace(/_/g, '{underscore}')}[${text}]`
+            : m
         })
       }
       if (~line.indexOf('image:') && !line.startsWith('image::')) {
@@ -289,9 +350,9 @@ function aggregateAsciiDoc (
           if (isResourceSpec(target)) {
             const image = contentCatalog.resolveResource(target, page.src, 'image', ['image'])
             // TODO: handle (or report) unresolved image better
-            if (image) {
+            if (image && image.out) {
               image.out.assembled = true
-              return `image:${image.pub.url.substr(1)}[${attrlist}]`
+              return `image:${image.out.path.replace(/_/g, '{underscore}')}[${attrlist}]`
             }
           }
           return m
@@ -331,14 +392,14 @@ function aggregateAsciiDoc (
           let prefix = ''
           // Q: can we use startsWith('image::') in certain cases?
           let imageMacroOffset = (
-            lastImageMacroAt?.[0] === idx ? line.substr(0, lastImageMacroAt[1]) : line
+            lastImageMacroAt?.[0] === idx ? line.slice(0, lastImageMacroAt[1]) : line
           ).lastIndexOf('image::')
           if (imageMacroOffset > 0) {
             if (
               block.getDocument().isNested() &&
-              (prefix = line.substr(0, imageMacroOffset)).trimRight().endsWith('|')
+              (prefix = line.slice(0, imageMacroOffset)).trimRight().endsWith('|')
             ) {
-              line = line.substr(prefix.length)
+              line = line.slice(prefix.length)
             } else {
               imageMacroOffset = -1
             }
@@ -348,9 +409,10 @@ function aggregateAsciiDoc (
             if (isResourceSpec(target)) {
               const image = contentCatalog.resolveResource(target, page.src, 'image', ['image'])
               // FIXME: handle (or report) case when image is not resolved
-              if (image) {
-                lines[idx] = `${prefix}image::${image.pub.url.substr(1)}${line.substr(line.indexOf('['))}`
+              if (image && image.out) {
+                const boxedAttrlist = line.slice(line.indexOf('['))
                 image.out.assembled = true
+                lines[idx] = `${prefix}image::${image.out.path}${boxedAttrlist}`
               }
             }
             lastImageMacroAt = [idx, imageMacroOffset]
@@ -375,7 +437,15 @@ function aggregateAsciiDoc (
             } else if (val !== initialVal) {
               accum.push(`:${name}:${initialVal ? ' ' + initialVal : ''}`)
             }
-          } else if (val != null && !(doc.isAttributeLocked(name) || name === 'doctype' || name === 'leveloffset')) {
+          } else if (
+            !(
+              val == null ||
+              doc.isAttributeLocked(name) ||
+              name === 'doctype' ||
+              name === 'leveloffset' ||
+              name === 'underscore'
+            )
+          ) {
             accum.push(`:!${name}:`)
           }
           return accum
@@ -384,43 +454,54 @@ function aggregateAsciiDoc (
       )
       if (resolvedAttributeEntries.length > 1) buffer.push(...resolvedAttributeEntries)
     }
-  } else {
-    if (level) {
-      if (level === 1 && navtitle === componentVersion.title) {
-        level--
-      } else {
-        buffer.push('')
-        // NOTE: try to toggle sectids; otherwise, fallback to globally unique synthetic ID
-        let toggleSectids, syntheticId
-        if (!('sectids' in asciidocConfig.attributes)) {
+  } else if (level) {
+    if (level === 1 && navtitlePlain === componentVersion.title) {
+      level--
+    } else {
+      buffer.push('')
+      // NOTE: try to toggle sectids; otherwise, fallback to globally unique synthetic ID
+      // Q: should we unset docname, page-module, etc?
+      let toggleSectids, syntheticId
+      if (!('sectids' in asciidocConfig.attributes)) {
+        buffer.push(':!sectids:')
+        toggleSectids = true
+      } else if (typeof asciidocConfig.attributes.sectids === 'string') {
+        if ('sectids' in mutableAttributes) {
           buffer.push(':!sectids:')
           toggleSectids = true
-        } else if (typeof asciidocConfig.attributes.sectids === 'string') {
-          if ('sectids' in mutableAttributes) {
-            buffer.push(':!sectids:')
-            toggleSectids = true
-          } else {
-            syntheticId = `__object-id-${global.Opal.hash(outlineEntry).$object_id()}`
-          }
+        } else {
+          syntheticId = `__object-id-${global.Opal.hash(outlineEntry).$object_id()}`
         }
-        // Q: should we unset docname, page-module, etc?
-        const sectionTitle = urlType === 'external' ? `${url}[${navtitle.replace(/\]/, '\\]')}]` : navtitle
-        let hlevel = level + 1
-        if (hlevel > 6) {
-          hlevel = 6
-          buffer.push(syntheticId ? `[discrete#${syntheticId}]` : '[discrete]')
-        } else if (syntheticId) {
-          buffer.push(`[#${syntheticId}]`)
+      }
+      let sectionTitle = navtitleAsciiDoc
+      if (urlType === 'external') {
+        sectionTitle = `${url}[${navtitlePass ? navtitleAsciiDoc : navtitleAsciiDoc.replace(/\]/g, '\\]')}]`
+      } else if (urlType === 'internal' && !unresolved && siteUrl) {
+        const resource = contentCatalog.getFiles().find((it) => it.pub.url === url)
+        if (resource?.out) {
+          sectionTitle = navtitlePass ? navtitleAsciiDoc : navtitleAsciiDoc.replace(/\]/g, '\\]')
+          sectionTitle = `${siteUrl}${resource.pub.url}[${sectionTitle}]`
         }
-        buffer.push(`${'='.repeat(hlevel)} ${sectionTitle}`)
-        if (toggleSectids) buffer.push(':sectids:')
       }
+      let hlevel = level + 1
+      if (hlevel > 6) {
+        hlevel = 6
+        buffer.push(syntheticId ? `[discrete#${syntheticId}]` : '[discrete]')
+      } else if (syntheticId) {
+        buffer.push(`[#${syntheticId}]`)
+      }
+      buffer.push(`${'='.repeat(hlevel)} ${sectionTitle}`)
+      if (toggleSectids) buffer.push(':sectids:')
     }
   }
 
   const nextLevel = level + 1
   if (items) {
-    items.forEach((item) => {
+    // NOTE: drop first child if same as parent; should we keep if content is different?
+    ;(urlType === 'internal' && urlType === items[0].urlType && url === items[0].url && !items[0].items
+      ? items.slice(1)
+      : items
+    ).forEach((item) => {
       buffer.push(
         ...aggregateAsciiDoc(
           loadAsciiDoc,
@@ -432,6 +513,7 @@ function aggregateAsciiDoc (
           asciidocConfig,
           mutableAttributes,
           sectionMergeStrategy,
+          lastComponentVersion,
           nextLevel
         )
       )
@@ -440,19 +522,12 @@ function aggregateAsciiDoc (
   return buffer
 }
 
-function generateStem (componentVersion, title) {
-  const { name, version } = componentVersion
-  const segments = []
-  if (name !== 'ROOT') segments.push(name)
-  if (version && version !== 'master') segments.push(version)
-  segments.push(
-    title
-      .toLowerCase()
-      .replace(/&.+?;|[^ \p{Alpha}0-9_\-.]/gu, '')
-      .replace(/[ _.]/g, '-')
-      .replace(/--+/g, '-')
-  )
-  return path.join(...segments)
+function generateSlug (title) {
+  return title
+    .toLowerCase()
+    .replace(/&.+?;|[^ \p{Alpha}0-9_\-.]/gu, '')
+    .replace(/[ _.]/g, '-')
+    .replace(/--+/g, '-')
 }
 
 function fixSectionLevels (sections, multipart) {
@@ -489,10 +564,10 @@ function rewriteStyleAttribute (block, lines, idx, idprefix, replacementStyle =
     let rawStyle
     const commaIdx = prevLine.indexOf(',')
     if (~commaIdx) {
-      rawStyle = prevLine.substr(1, commaIdx - 1)
+      rawStyle = prevLine.slice(1, commaIdx - 1)
       if (~rawStyle.indexOf('=')) rawStyle = undefined
     } else if (!~prevLine.indexOf('=')) {
-      rawStyle = prevLine.substr(1, prevLine.length - 2)
+      rawStyle = prevLine.slice(1, prevLine.length - 2)
     }
     if (rawStyle) {
       if (~rawStyle.indexOf('#')) {
@@ -500,11 +575,11 @@ function rewriteStyleAttribute (block, lines, idx, idprefix, replacementStyle =
         if (replacementStyle) prevLine = prevLine.replace(/^[^#.%,\]]+/, `[${replacementStyle}`)
       } else {
         prevLine = `[${
-          replacementStyle ? rawStyle.replace(/^[^.%]*]/, replacementStyle) : rawStyle
-        }#${idprefix}${block.getId()}${prevLine.substr(rawStyle.length + 1)}`
+          replacementStyle ? rawStyle.replace(/^[^.%]*/, replacementStyle) : rawStyle
+        }#${idprefix}${block.getId()}${prevLine.slice(rawStyle.length + 1)}`
       }
     } else {
-      prevLine = `[${replacementStyle}#${idprefix}${block.getId()}${rawStyle == null ? ',' : ''}${prevLine.substr(1)}`
+      prevLine = `[${replacementStyle}#${idprefix}${block.getId()}${rawStyle == null ? ',' : ''}${prevLine.slice(1)}`
     }
     if (cellSpec) prevLine = `${cellSpec}|${prevLine}`
     lines[idx - 1] = prevLine

package/lib/produce-aggregate-documents.js

@@ -1,14 +1,18 @@
 'use strict'
 
+const File = require('vinyl')
 const filterComponentVersions = require('./filter-component-versions')
 const produceAggregateDocument = require('./produce-aggregate-document')
 const selectMutableAttributes = require('./select-mutable-attributes')
 
+const IMAGE_MACRO_RX = /^image::?(.+?)\[(.*?)\]$/
+
 function produceAggregateDocuments (loadAsciiDoc, contentCatalog, assemblerConfig) {
   const { insertStartPage, rootLevel, sectionMergeStrategy, asciidoc: assemblerAsciiDocConfig } = assemblerConfig
   const assemblerAsciiDocAttributes = Object.assign({}, assemblerAsciiDocConfig.attributes)
-  const { doctype, 'source-highlighter': sourceHighlighter } = assemblerAsciiDocAttributes
+  const { doctype, revdate, 'source-highlighter': sourceHighlighter } = assemblerAsciiDocAttributes
   delete assemblerAsciiDocAttributes.doctype
+  delete assemblerAsciiDocAttributes.revdate
   delete assemblerAsciiDocAttributes['source-highlighter']
   return filterComponentVersions(contentCatalog.getComponents(), assemblerConfig.componentVersions).reduce(
     (accum, componentVersion) => {
@@ -16,22 +20,34 @@ function produceAggregateDocuments (loadAsciiDoc, contentCatalog, assemblerConfi
       if (!navigation) return accum
       const componentVersionAsciiDocConfig = getAsciiDocConfigWithAsciidoctorReducerExtension(componentVersion)
       const mergedAsciiDocConfig = Object.assign({}, componentVersionAsciiDocConfig, {
-        attributes: Object.assign({}, componentVersionAsciiDocConfig.attributes, assemblerAsciiDocAttributes),
+        attributes: Object.assign({ revdate }, componentVersionAsciiDocConfig.attributes, assemblerAsciiDocAttributes),
+      })
+      const mergedAsciiDocAttributes = mergedAsciiDocConfig.attributes
+      Object.entries(mergedAsciiDocAttributes).forEach(([name, val]) => {
+        const match = name.endsWith('-image') && val.startsWith('image:') && IMAGE_MACRO_RX.exec(val)
+        if (!(match && isResourceRef(match[1]))) return
+        // Q should we allow image to be resolved relative to component version?
+        const image = contentCatalog.resolveResource(match[1], undefined, 'image', ['image'])
+        if (!image?.out) return
+        mergedAsciiDocAttributes[name] = `image:${image.out.path}[${match[2]}]`
+        image.out.assembled = true
       })
       const rootEntry = { content: title }
-      const startPage = contentCatalog.getComponentVersionStartPage(componentName, version)
-      let startPageUrl
-      if (startPage && insertStartPage) {
-        if (includedInNav(navigation, (startPageUrl = startPage.pub.url))) {
-          startPageUrl = undefined
-        } else {
-          Object.assign(rootEntry, { url: startPageUrl, urlType: 'internal' })
+      let startPage = contentCatalog.getComponentVersionStartPage(componentName, version)
+      if (startPage && startPage.src.component === componentName && startPage.src.version === version) {
+        if (insertStartPage && !includedInNav(navigation, startPage.pub.url)) {
+          Object.assign(rootEntry, { url: startPage.pub.url, urlType: 'internal' })
         }
+      } else {
+        // Q: should we always use a reference page as startPage for computing mutableAttributes?
+        startPage = createFile({
+          component: componentVersion.name,
+          version: componentVersion.version,
+          relative: '.reference-page.adoc',
+          origin: (componentVersion.origins || [])[0],
+        })
       }
-      // Q: should we use an artificial page instead or as fallback?
-      const mutableAttributes = startPage
-        ? selectMutableAttributes(loadAsciiDoc, contentCatalog, startPage, mergedAsciiDocConfig)
-        : {}
+      const mutableAttributes = selectMutableAttributes(loadAsciiDoc, contentCatalog, startPage, mergedAsciiDocConfig)
       delete mutableAttributes.doctype
       accum = accum.concat(
         prepareOutlines(navigation, rootEntry, rootLevel).map((outline) =>
@@ -48,16 +64,40 @@ function produceAggregateDocuments (loadAsciiDoc, contentCatalog, assemblerConfi
           )
         )
       )
-      mergedAsciiDocConfig.attributes.doctype = doctype
+      mergedAsciiDocAttributes.doctype = doctype
       sourceHighlighter
-        ? (mergedAsciiDocConfig.attributes['source-highlighter'] = sourceHighlighter)
-        : delete mergedAsciiDocConfig.attributes['source-highlighter']
+        ? (mergedAsciiDocAttributes['source-highlighter'] = sourceHighlighter)
+        : delete mergedAsciiDocAttributes['source-highlighter']
       return accum
     },
     []
   )
 }
 
+function createFile (src) {
+  const familySegment = (src.family ??= 'page') + 's'
+  const path = `modules/${(src.module ??= 'ROOT')}/${familySegment}/${src.relative}`
+  const moduleRootPath = Array(src.relative.split('/').length - 1)
+    .fill('..')
+    .join('/')
+  const outPath = [
+    src.component === 'ROOT' ? '' : src.component,
+    src.version,
+    src.module === 'ROOT' ? '' : src.module,
+    src.family === 'page' ? '' : '_' + familySegment,
+    src.family === 'page' ? src.relative.replace(/\.adoc$/, '.html') : src.relative,
+  ]
+    .filter((it) => it)
+    .join('/')
+  return new File({
+    path,
+    contents: src.contents ?? Buffer.alloc(0),
+    src,
+    out: { path: outPath },
+    pub: { url: '/' + outPath, moduleRootPath },
+  })
+}
+
 function getAsciiDocConfigWithAsciidoctorReducerExtension (componentVersion) {
   const asciidoctorReducerExtension = require('./asciidoctor/reducer-extension') // NOTE: must be required lazily
   const asciidocConfig = componentVersion.asciidoc
@@ -81,13 +121,20 @@ function includedInNav (items, url) {
   return items.find((it) => it.url === url || includedInNav(it.items || [], url))
 }
 
+function isResourceRef (target) {
+  return ~target.indexOf(':') && !(~target.indexOf('://') || (target.startsWith('data:') && ~target.indexOf(',')))
+}
+
+// when root level is 0, merge the navigation into the rootEntry
+// when root level is 1, create navigation per navigation menu
+// in this case, if there's only a single navigation menu with no title, promote each top-level item to a menu
 function prepareOutlines (navigation, rootEntry, rootLevel) {
   if (rootLevel === 0 || navigation.length === 1) {
     const navBranch =
       navigation.length === 1
         ? navigation[0]
         : { items: navigation.reduce((navTree, it) => navTree.concat(it.content ? it : it.items), []) }
-    return [Object.assign(rootEntry, navBranch)]
+    return rootLevel === 0 || navBranch.content ? [Object.assign(rootEntry, navBranch)] : navBranch.items
   }
   return navigation.reduce((navTree, it) => navTree.concat(it.content ? it : it.items), [rootEntry])
 }

package/lib/util/lazy-readable.js

@@ -1,6 +1,6 @@
 'use strict'
 
-const { PassThrough } = require('stream')
+const { PassThrough } = require('node:stream')
 
 // adapted from https://github.com/jpommerening/node-lazystream/blob/master/lib/lazystream.js | license: MIT
 class LazyReadable extends PassThrough {

package/lib/util/run-command.js

@@ -1,8 +1,8 @@
 'use strict'
 
-const fs = require('fs')
+const fs = require('node:fs')
 const LazyReadable = require('./lazy-readable')
-const { spawn } = require('child_process')
+const { spawn } = require('node:child_process')
 
 const IS_WIN = process.platform === 'win32'
 const DBL_QUOTE_RX = /"/g

package/lib/util/sanitize.js

@@ -0,0 +1,15 @@
+'use strict'
+
+const XML_TAG_RX = /<[^>]+>/g
+const XML_SPECIAL_CHARS = { '&lt;': '<', '&gt;': '>', '&amp;': '&' }
+const XML_SPECIAL_CHARS_RX = /&(?:[lg]t|amp);/g
+
+function sanitize (str) {
+  return ~str.indexOf('<')
+    ? [str.replace(XML_TAG_RX, '').replace(XML_SPECIAL_CHARS_RX, (m) => XML_SPECIAL_CHARS[m]), `+++${str}+++`, true]
+    : ~str.indexOf('&')
+        ? Array(2).fill(str.replace(XML_SPECIAL_CHARS_RX, (m) => XML_SPECIAL_CHARS[m]))
+        : [str, str]
+}
+
+module.exports = sanitize

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@antora/assembler",
-  "version": "1.0.0-alpha.6",
+  "version": "1.0.0-alpha.8",
   "description": "An extension library for Antora that assembles content from multiple pages into a single AsciiDoc file to converted and publish.",
   "license": "MPL-2.0",
   "author": "OpenDevise Inc. (https://opendevise.com)",
@@ -15,8 +15,8 @@
   },
   "scripts": {
     "test": "_mocha test",
-    "prepublishOnly": "node $npm_config_local_prefix/npm/prepublishOnly.js",
-    "postpublish": "node $npm_config_local_prefix/npm/postpublish.js"
+    "prepublishOnly": "npx -y downdoc --prepublish",
+    "postpublish": "npx -y downdoc --postpublish"
   },
   "main": "lib/index.js",
   "exports": {
@@ -31,13 +31,13 @@
   "dependencies": {
     "@antora/expand-path-helper": "~2.0",
     "braces": "~3.0",
-    "picomatch": "~2.3",
+    "picomatch": "~3.0",
     "vinyl": "~2.2",
     "js-yaml": "~4.1"
   },
   "devDependencies": {
-    "@antora/asciidoc-loader": "3.0.1",
-    "@antora/site-publisher": "3.0.1"
+    "@antora/asciidoc-loader": "~3.1",
+    "@antora/site-publisher": "~3.1"
   },
   "engines": {
     "node": ">=16.0.0"