Antora Roadmap

This roadmap outlines the current development direction and schedule for Antora. It’s intended for informational purposes only. The proposed features, their scope, and the release timeframes are estimates, not firm commitments.

Antora core components

For a detailed list of current development tasks, refer to the Antora issue tracker.

v2.1.x

Release Timeframe: Q1 2019

  • Upgrade build to Gulp 4 #370

  • Automatically set up latest version URLs #314

  • Contents of xref should use page title if contents is not specified #310

  • Resolve symlinks (possibly just file symlinks) in git tree #188

  • Add a logging infrastructure; configure Asciidoctor logger to use it #145

  • Allow AsciiDoc attributes to be specified per component-version (in antora.yml) #251

  • Implement fallback value for component version based on git ref or config #296

  • Provide a better way to indicate that a component version is "versionless"

  • Implicitly disable branches pattern if tags pattern is specified in content source #268

  • Allow AsciiDoc content to be included from a URL #246

  • Add support to include processor for including lines by line number

  • Add initial support for translations by adding language key to virtual file

  • Provide access to cached repositories in Antora context (as src.origin.cacheDir) #305

  • Use worktree of local git repository even when repository has no commits #298

  • Don’t set canonical URL if page doesn’t exist in latest version of component (otherwise, this confuses crawlers)

  • Publish metapackage @antora/antora to simplify installation

v2.2.x

Release Timeframe: Q2 2019

  • Make module path configurable (using antora.yml) #28

  • Add support for a moduleless docs component #27

  • Add watch mode for files in worktree #329

  • Allow pattern for edit URL to be configurable #292

  • Add PDF output option for pages and/or components #349

  • Show the file url where the site can be previewed offline #220

  • Add authentication for remote UI bundles #280

  • Support loading the UI from a directory #150

  • Add support for referencing images across modules

  • Add xref support to image link #330

  • Add support for referencing attachments using xref macro #227

  • Add priority boosts in sitemap based on component version #317

  • Compose playbook files (include one into another)

  • Integrate lunr search into default site generator (or promote the extension and make it easier to enable)

  • Automatically substitute environment variables in playbook file

v3.0.x

Release Timeframe: Q4 2019

  • Add lifecycle hooks to default site generator

  • Add support for git-lfs for assets storage such as images #185

Unscheduled

The capabilities and features in this section have been proposed and tentatively accepted as future work tasks. They aren’t slated for imminent development but are reviewed for possible scheduling after each release.

  • Add algolia keys (app ID, API key, and index name) to playbook schema

  • Add support for using template languages other than Handlebars in the UI (e.g., pugjs)

  • Set up repositories for site-publisher-s3 and site-publisher-sftp

  • Add scaffolding commands to CLI to create a new component, module, or page

  • Set up API documentation and automatically publish as CI artifact

  • Generate a robots.txt file (perhaps configured in site.yml) #219

  • Add context as second argument to ContentCatalog#addFile #209

  • Allow supplemental files to be fetched and added to the content catalog #195

  • Add (Apache) httpd redirect facility to redirect producer #192

  • Allow static redirect page to be customized using a UI template #191

  • Allow page alias to be an explicit URI pathname #190

  • Add a merge mode to supplemental UI files #149

  • Allow a component to be promoted to the site root #132

  • Decide whether content aggregate should be sorted #121

  • Ignore duplicate component in same repository if it matches component in HEAD #120

  • Set up UI acceptance test suite #95

  • Add option to playbook to skip/bypass worktree(s) in local repositories #82

  • Set up webhooks between repositories (e.g., docs.antora.org, docker-antora)

  • Component to host mapping, not just one site URL

  • Decide whether to isolate id (or ctx) from src property on content file

  • Be able to make references to page aliases; would require parsing all document headers in a separate step/phase

  • contentCatalog.resolvePage()

  • set antora-version AsciiDoc attribute

  • Separate site publisher from providers

  • Evaluate new strategies for interpreting equations (e.g., build-time conversion to SVG)

Discussions
  • Properly store generated PlantUML images directly in Antora content folder instead of output directory (Requirements: #189)

Antora documentation, demo, and sites

For current Antora documentation tasks, see the Antora issue tracker.

For current demo tasks, see the Demo materials issue tracker.

For current docs.antora.org tasks, see the site issue tracker.

v2.1.x

Release Timeframe: Q1 2019

  • Explain how to create a partial page #176

  • Document the page- attributes #177

  • Add quick start guide #299

  • Document how Antora selects the latest version #311

  • Document list of environment variables as page (or as appropriate) in CLI module

  • Partition the CLI options into two tables, general options and generate options

  • Create community participation guidelines

  • Add changelog (mirror/link) to Docs

  • Add contributing guide (mirror/link) to Docs

  • Remove most documentation-type content from README and replace with links to the appropriate Docs pages

Unscheduled

Docs
  • Improve custom publish provider documentation #164

  • Document sitemap features #168

  • Document how to create user-defined page attributes

  • Document stem functionality with common UI integration scenarios

  • Document how to add MathJax integration to the UI

  • Document how to integrate external Javascript files with the UI

Sites
  • Create dedicated UI project and bundle for docs.antora.org instead of using supplemental UI

  • Mirror/link maintenance and bug fix priority policies on antora.org

  • Mirror/link release schedule on project site

Antora default UI

For a detailed list of current development tasks, refer to the UI issue tracker.

v1.0.0

Release Timeframe: Q1 2019

  • Upgrade build to Gulp 4

  • Split off base UI from default UI; make default UI configurable from playbook

  • Add client-side search (algolia docsearch) #44

  • Cut stable release of default UI

  • Support sample content for preview pages written in AsciiDoc

  • Upgrade preview site sample content #20

Unscheduled

  • Create task list SVGs #31

  • Enable unordered list marker styles #26

  • Extract all colors into CSS variables #18

  • Allow SVGs to be embedded directly into Handlebars template