v1.0.0-alpha.16

What's Changed

• Publish asciidoctor-web-pdf as a Docker image on Docker hub: https://hub.docker.com/r/ggrossetie/asciidoctor-web-pdf by @cinhtau

New Contributors

• @cinhtau

Full Changelog: v1.0.0-alpha.15...v1.0.0-alpha.16

v1.0.0-alpha.15

What's Changed

• Introduce PUPPETEER_PRINT_TIMEOUT for puppeteer PDF rendering by @siaccarino in #632
• Update GitHub Actions by @Mogztter in #638
• Update Node dependencies by @Mogztter in #639 #640
• Remove orphaned table headers at page breaks by @patrickluoyu in #663

New Contributors

• @siaccarino made their first contribution in #632
• @patrickluoyu

Full Changelog: v1.0.0-alpha.14...v1.0.0-alpha.15

v1.0.0-alpha.14

Release meta

Released on: 2020-11-23
Released by: GitHub Actions
Published by: GitHub Actions

Logs: full diff

Changelog

Breaking changes

• Drop Node.js 10 support

Bug fixes

• Encode section ID (#340)

Improvements

• Add support for Apple Silicon / M1
• Add support for footnotes (#550)
• Add support for Paged.js hooks (#513) - thanks @danyill
• Use the latest version of Paged.js
  • preserve white spaces in <pre> elements
  • ensure that styles remain in the same order
  • ignore undefined border
• Upgrade dependencies
  • Bump puppeteer from 7.1.0 to 11.0.0
  • Bump pdf-lib to 1.17.1
  • Bump chokidar to 3.5.2
  • Bump mathjax to 3.2.0
  • Bump html-entities to 2.3.2
  • Bump @fortawesome/fontawesome-svg-core to 1.2.36
  • Bump @fortawesome/free-solid-svg-icons to 5.15.4
  • Bump @fortawesome/free-regular-svg-icons to 5.15.4
  • Bump @fortawesome/free-brands-svg-icons to 5.15.4
• Upgrade development dependencies
  • Bump fs-extra to 10.0.0
  • Bump pacote to 12.0.2
  • Bump pkg to 5.4.1
  • Bump sinon to 12.0.1
  • Bump mocha to 9.1.3
  • Bump pacote to 11.3.5
  • Bump cheerio to 1.0.0-rc.10
  • Bump libnpmpublish to 4.0.2
  • Bump chai to 4.3.4
  • Bump archiver to 5.3.0
• Update main branch name from master to main
• Run npm audit fix

Infrastructure

• Chromium download status implementation using ANSI escape chars only (fixes local performance problem) - thanks @wh81752
• Smoke test improvements - thanks @wh81752
• Add a root-folder in distribution bundles (zip files) - thanks @wh81752
• Ignore Intellij's IDEA folder - thanks @wh81752
• Upgrade to GitHub-native Dependabot
• Extract the release version from github.ref in the GitHub Action

Documentation

• Fix typo in the README - thanks @matklad
• Add a dedicated README per example - thanks @wh81752
• Fix instructions to generate I/O slides
• Use section titles for linking in the README
• Recommend to use npm init -y in the README
• Update Node.js version (to latest LTS) in the README
• Improve the install documentation

v1.0.0-alpha.12

Summary

This version includes several usability improvements.
First, Asciidoctor Web PDF is now also available as a pre-compiled binary for Linux, macOS and Windows.
In other words, you can download and run the asciidoctor-web-pdf binary from the Command Line Interface without additional installation steps 🎉 🎉 🎉
We would like to thank @danyill for his work on this feature!

In addition, Asciidoctor Web PDF now generates more accessible PDFs by enabling the experimental tagged PDFs feature introduced in Chromium 85.
A tagged PDF is one that contains extra metadata about the structure of a document, including things like headings, lists, tables, paragraphs, and image descriptions
Again, this feature was contributed by a community member! Thanks @webpigeon!

Notable changes include allowing to specify an executable path for Chromium (using PUPPETEER_EXECUTABLE_PATH environment variable)
and adding support for Docinfo files.

Consult the Changelog section for the complete list of changes.

Release meta

Released on: 2020-02-19
Released by: GitHub Actions
Published by: GitHub Actions

Logs: full diff

Changelog

Improvements

• Produce binaries for Linux, macOS and Windows - thanks @danyill
  • Go to the releases page and download the appropriate binary for your platform.
    Extract this to a folder of your choosing.
    From a command line in this folder you can then run the asciidoctor-web-pdf command.
• Add support for tagged (accessible) PDFs - thanks @webpigeon
• Allow to specify a custom path for Chromium using the PUPPETEER_EXECUTABLE_PATH environment variable (#394)
• Allow including stylesheets in addition to the default styles using the + prefix (#298)

$ asciidoctor-web-pdf document.adoc -a stylesheet="+custom.css"

• Add support for Docinfo files (#147)
  • 4 locations available: head, header, footer and running
• Use the latest version of Paged.js
  • preserve white spaces in <pre> elements
  • ensure that styles remain in the same order
  • ignore undefined border
• Upgrade dependencies
  • Bump puppeteer from 5.5.0 to 7.1.0
  • Bump pdf-lib from 1.12.0 to 1.16.0
  • Bump yargs from 16.1.1 to 16.2.0
  • Bump html-entities from 1.3.1 to 2.1.0
  • Bump chokidar from 3.4.3 to 3.5.1
  • Bump @fortawesome/fontawesome-svg-core from 1.2.32 to 1.2.34
  • Bump @fortawesome/free-solid-svg-icons from 5.15.1 to 5.15.2
  • Bump @fortawesome/free-regular-svg-icons from 5.15.1 to 5.15.2
  • Bump @fortawesome/free-brands-svg-icons from 5.15.1 to 5.15.2
• Upgrade development dependencies
  • Bump sinon from 9.2.1 to 9.2.4
  • Bump cheerio from 1.0.0-rc.3 to 1.0.0-rc.5
  • Bump fs-extra from 9.0.1 to 9.1.0
  • Bump chai from 4.2.0 to 4.3.0
  • Bump mocha from 8.2.1 to 8.3.0
  • Bump @asciidoctor/core from 2.2.0 to 2.2.1
  • Bump nunjucks from 3.2.2 to 3.2.3
  • Bump pacote from 11.2.6 to 11.2.7

Documentation

• Add a complete example on how to add a complex footer (with or without using a Docinfo file)
• Document how to use a front cover image
• Document Chromium command line options

Infrastructure

• Automate the release using GitHub Actions

v1.0.0-alpha.11

Summary

This version includes a fix about the TOC feature introduced in v1.0.0-alpha.10.
In fact, the TOC list items style was wrongly applied on other list item elements (i.e., unordered and ordered lists).
This version also slightly adjusts the default margins as the top margin was very slim (0.15 inches).

Release meta

Released on: 2020-12-06
Released by: @Mogztter
Published by: @Mogztter

Logs: full diff

Changelog

Bug fixes

• Reduce style scope on TOC list items - thanks @gquintana

Improvements

• Adjust the default margins (#359) - thanks @DanielSWolf
• Upgrade dependencies
  • Bump puppeteer from 5.3.1 to 5.5.0
  • Bump yargs from 16.1.0 to 16.1.1
  • Bump pdf-lib from 1.11.2 to 1.12.0
• Upgrade development dependencies
  • Bump mocha from 8.2.0 to 8.2.1
  • Bump sinon from 9.2.0 to 9.2.1
  • Bump standard from 14.3.4 to 16.0.3
  • Bump @asciidoctor/core from 2.2.0 to 2.2.1

Infrastructure

• Run apt-get update before apt-get install to ensure compatibility with the latest runner (Ubuntu 20.04)
• Add a sponsor button

v1.0.0-alpha.10

Summary

This version introduces a major overhaul of the page numbering system.
In addition, the page numbers are now visible on the Table Of Contents:

This version also includes improvements regarding long tables and tables with rowspan.
In most cases, Paged.js will now correctly chunk the table 🎉

⚠️ Please note that asciidoctor-pdf is now deprecated, please use asciidoctor-web-pdf instead.

Release meta

Released on: 2020-10-19
Released by: @Mogztter
Published by: @Mogztter

Logs: full diff

Changelog

Deprecation warnings

• Add a deprecation warning when using asciidoctor-pdf, please use asciidoctor-web-pdf instead (#286)

Bug fixes

• When a table is chunked the <colgroup> and <caption> are now repeated/preserved (#297)
• Prevent the ToC from being put off-canvas when using :toc: left or :toc: right (#307) - thanks @gquintana
• Fix an issue where AsciiDoc counters (i.e. {counter:seq1}) were incorrectly incremented (#319)

Improvements

• Add page numbers on the TOC (#237) - thanks @djencks
• Major overhaul of the page numbering system
• Remove horizontal delimiters (1px borders) between sections
• Slightly reduce the top margin on titles
• Upgrade dependencies
  • Update Paged.js to 0.1.43-next.1603099319
  • Bump puppeteer from 5.2.1 to 5.3.1
  • Bump mathjax from 3.0.5 to 3.1.2
  • Bump yargs from 15.4.1 to 16.1.0
  • Bump chokidar from 3.4.2 to 3.4.3
  • Bump pdf-lib from 1.10.0 to 1.11.2
  • Bump @fortawesome/fontawesome-svg-core from 1.2.30 to 1.2.32
  • Bump @fortawesome/free-regular-svg-icons from 5.14.0 to 5.15.1
  • Bump @fortawesome/free-brands-svg-icons from 5.14.0 to 5.15.1
  • Bump @fortawesome/free-solid-svg-icons from 5.14.0 to 5.15.1
• Upgrade development dependencies
  • Bump bl from 4.0.2 to 4.0.3 [Security]
  • Bump mocha from 8.1.1 to 8.2.0
  • Bump sinon from 9.0.3 to 9.2.0

Infrastructure

• Build against Node.js 12 LTS and 14 current

v1.0.0-alpha.9

Summary

Release meta

Released on: 2020-08-14
Released by: @Mogztter
Published by: @Mogztter

Logs: full diff

Changelog

Bug fixes

• Set basebackend to html to fix syntax highlighting (regression 7397e36) - thanks @abelsromero

Improvements

• Declare attributes env-web-pdf and env=web-pdf
• Bump @fortawesome/fontawesome-svg-core from 1.2.28 to 1.2.30
• Bump @fortawesome/free-regular-svg-icons from 5.13.0 to 5.14.0
• Bump @fortawesome/free-solid-svg-icons from 5.13.0 to 5.14.0
• Bump @fortawesome/free-brands-svg-icons from 5.13.0 to 5.14.0
• Bump yargs from 15.3.1 to 15.4.1
• Bump pagedjs from 0.1.41 to 0.1.42
• Bump pdf-lib from 1.4.1 to 1.10.0
• Bump chokidar from 3.3.1 to 3.4.2
• Bump puppeteer from 3.3.0 to 5.2.1
• Upgrade development dependencies
  • Bump nunjucks from 3.2.1 to 3.2.2
  • Bump sinon from 9.0.2 to 9.0.3
  • Bump lodash from 4.17.15 to 4.17.19
  • Bump pixelmatch from 5.2.0 to 5.2.1
  • Bump mocha from 8.0.1 to 8.1.1

Documentation

• Add a link to the Puppeteer troubleshoot page
• Rename "Asciidoctor PDF" to "Asciidoctor Web PDF"

v1.0.0-alpha.8

Summary

Release meta

Released on: 2020-06-13
Released by: @Mogztter
Published by: @Mogztter

Logs: full diff

Changelog

Breaking changes

• Requires Node > 10 and npm > 6

Bug fixes

• await browser.close to make sure that Chrome is closed

Improvements

• Allow to configure timeouts: PUPPETEER_DEFAULT_TIMEOUT, PUPPETEER_NAVIGATION_TIMEOUT, PUPPETEER_RENDERING_TIMEOUT
• Add asciidoctor-web-pdf as a bin alias
• Integrate with the new built-in template converter from Asciidoctor.js

$ asciidoctor-pdf -T ./templates doc.adoc

• Upgrade Paged.js to 0.1.41
• Upgrade MathJax from 3.0.1 to 3.0.5
• Use Invoker.readFromStdin from @asciidoctor/cli
• Use comma as stylesheet delimiter (instead of semi-colon) - thanks @makon
• Upgrade FontAwesome from 5.11.2 to 5.13.0
• Use the new setLanguage API from pdf-lib
• Upgrade html-entities from 1.2.1 to 1.3.1
• Upgrade pdf-lib from 1.2.1 to 1.4.1
• Upgrade chokidar from 2.0.4 to 3.3.1
• Upgrade yargs from 13.2.2 to 15.3.1

Infrastructure

• Upgrade development dependencies
  • Bump standard from 14.3.3 to 14.3.4
  • Bump puppeteer from 2.0.0 to 3.3.0
  • Bump pixelmatch from 5.1.0 to 5.2.0
  • Bump mocha from 6.2.0 to 8.0.1
  • Bump @asciidoctor/cli from 3.3.0 to 3.4.0
  • Bump fs-extra from 8.1.0 to 9.0.1
  • Bump rimraf from 3.0.0 to 3.0.2
  • Bump acorn from 7.0.0 to 7.1.1
• Disable Travis CI (in favor of GitHub Actions)
• Add a test on STEM support
• Use local images in the cheat-sheet example (avatars.io service has shutdown)

Documentation

• Explain how to use Asciidoctor extensions
• Replace the verb "require" by "use" or "load" depending on the context

v1.0.0-alpha.7

Summary

Release meta

Released on: 2020-03-03
Released by: @Mogztter
Published by: @Mogztter

Logs: full diff

Changelog

Bug fixes

• Fix --watch option (regression c9dc3d3)

Improvements

• Upgrade MathJax to 3.0.1
• Upgrade to Paged.js 0.1.39

v1.0.0-alpha.6

Summary

Release meta

Released on: 2020-02-01
Released by: @Mogztter
Published by: @Mogztter

Logs: full diff

Changelog

Improvements

• allow to extend the default document converter