Skip to content

Latest commit

 

History

History
53 lines (29 loc) · 1.42 KB

README.md

File metadata and controls

53 lines (29 loc) · 1.42 KB

Asciidoc-deck.js

A Deck.js backend for asciidoc.

Dependencies

  • AsciiDoc
  • Deck.js (included in the backend package)

Optional:

  • If you want to highlight source code, please install Pygments or source-highlight.

Installation

Download the backend package and use asciidoc to install:

asciidoc --backend install deckjs-1.2.zip

This will install the backend to ~/asciidoc/backend/deckjs.

You can also use this backend without installation, see the next section.

Usage

With deckjs backend installed, use following command to generate slides:

asciidoc -b deckjs file.asciidoc

To use without Installation, you need to specify different argument:

asciidoc -f deck.js.conf file.asciidoc

Make sure your asciidoc can properly find deckjs.conf. For asciidoc's configuration file loading strategy, please refer to this guide.

Note that without installation, you also have to enable linkcss option. Then put deck.js, ad-stylesheet and generated slide into the same directory. Checkout the template file for how to enable all kinds of options.