PDF exporter for HTML presentations
Go to file
astefanutti 591e14155b Add generic plugin to support any kind of presentation frameworks
The generic plugin emulates the end-user interaction by pressing the
specified key [--keycode] and iterating over the presentation as long as
any change to the DOM is detected by observing mutation events to the body
element and its subtree.

To support the generic plugin feature, the following enhancements are
introduced:
- Move to promises based navigation scheduling
- Build CLI commands directly from available plugins
- Enable per plugin CLI help and options
- Enable by-command overriding of the selected plugin
2015-07-08 17:41:40 +02:00
bin Add Mac OS X (Cocoa) 64-bit install instruction 2015-06-03 23:17:56 +02:00
libs Add generic plugin to support any kind of presentation frameworks 2015-07-08 17:41:40 +02:00
phantomjs@291cefa183 Rebase to PhantomJS with upgraded Qt 5.4.1 2015-06-29 23:03:41 +02:00
plugins Add generic plugin to support any kind of presentation frameworks 2015-07-08 17:41:40 +02:00
.gitmodules Initial commit 2015-05-07 19:09:07 +02:00
decktape.js Add generic plugin to support any kind of presentation frameworks 2015-07-08 17:41:40 +02:00
phantomjs.json Add default PhantomJS configuration 2015-05-28 22:53:01 +02:00
README.md Simplify submodule update command 2015-07-07 02:17:24 -06:00

DeckTape

DeckTape is a high-quality PDF exporter for HTML5 presentation frameworks. It supports all the features that you would expect from a PDF exporter like font embedding, selectable text, hyperlinks, SVG graphics objects, file compression.

DeckTape is built on top of PhantomJS which relies on WebKit Qt for laying out and rendering Web pages and provides a headless WebKit scriptable with a JavaScript API.

DeckTape currently supports the CSSS, deck.js, DZSlides, flowtime.js, HTML Slidy, impress.js, remark.js, reveal.js and Shower presentation frameworks out-of-the-box. Besides, it exposes a plugin-based extension API so that it is possible to add support for other frameworks or tailored existing ones to your specific needs.

You can browse some slide deck examples below that have been exported with DeckTape.

Install

  1. Clone DeckTape Git repository:

     git clone https://github.com/astefanutti/decktape.git
    
  2. Change into the decktape directory:

     cd decktape
    
  3. Dowload PhantomJS executable: DeckTape currently depends on a forked version of PhantomJS. You can get the corresponding binaries for the platforms above:

     # Windows (MSVC 2013), 64-bit, for Windows Vista or later, bundles VC++ Runtime 2013
     curl -L http://a9i.io/decktape/downloads/phantomjs-msvc2013-win64.exe -o bin\phantomjs.exe
    
     # Mac OS X (Cocoa), 64-bit, for OS X 10.6 or later
     curl -L http://a9i.io/decktape/downloads/phantomjs-osx-cocoa-x86-64 -o bin/phantomjs
     chmod +x bin/phantomjs
    

    If the executable isn't available for your target plaform, see the Build section and follow the instructions.

Usage

Into DeckTape install directory:

bin/phantomjs decktape.js -h

Usage: phantomjs decktape.js <url> <filename> [options]

url          URL of the slides deck
filename     Filename of the output PDF file

Options:
   --width    Width of the slides deck  [1280]
   --height   Height of the slides deck  [720]
   --pause    Duration in milliseconds before the next slide is exported  [1000]

Build

To build the forked version of PhantomJS whose DeckTape relies on, you have to execute the following commands from the DeckTape install directory:

  1. Initialize and check out the phantomjs submodule:

     git submodule update --init
    
  2. Change into the phantomjs directory:

     cd phantomjs
    
  3. Launch the build script:

     build
    

More information can be found in Compiling PhantomJS from source and in Building Qt 5 from Git.

Plugins

✏️

Examples

The following slide deck examples have been exported using DeckTape:

HTML5 Presentation Framework Exported PDF
Beyond Rectangles in Web Design reveal.js 2.6.2 fowd-nyc-2014.pdf (14MB)
Getting Involved in Open Source reveal.js 3.0.0 opensource-getting-involved.pdf (0.8MB)
Going Further with CDI Asciidoctor + DZSlides going-further-with-cdi.pdf (1.8MB)
Transactions for the REST of us impress.js 0.5.3 soa-cloud-rest-tcc.pdf (10MB)
Deck.js Modern HTML Presentations deck.js 1.1.0 deck-js-presentation.pdf (1.1MB)
Flowtime.js Presentation Framework flowtime.js flowtime-js-presentation.pdf (7.5MB)
The Official Remark Slideshow remark.js 0.11.0 remark-js-slideshow.pdf (0.7MB)
HTML Slidy: Slide Shows in HTML and XHTML HTML Slidy html-slidy-presentation.pdf (0.5MB)
CSSS: CSS-based SlideShow System CSSS csss-sample-slideshow.pdf (13.5MB)
Shower Presentation Engine Shower shower-presentation-engine.pdf (0.4MB)