https://github.com/houqp/asciidoc-deckjs

A deck.js backend for asciidoc
https://github.com/houqp/asciidoc-deckjs

Last synced: 25 days ago
JSON representation

A deck.js backend for asciidoc

• Host: GitHub
• URL: https://github.com/houqp/asciidoc-deckjs
• Owner: houqp
• License: gpl-2.0
• Created: 2011-12-15T15:58:49.000Z (almost 13 years ago)
• Default Branch: master
• Last Pushed: 2014-06-30T09:25:04.000Z (over 10 years ago)
• Last Synced: 2024-10-04T18:22:36.824Z (about 1 month ago)
• Language: CSS
• Homepage: http://houqp.github.com/asciidoc-deckjs
• Size: 669 KB
• Stars: 39
• Watchers: 5
• Forks: 8
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG

Awesome Lists containing this project

README

        
# 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][deckjs] and use asciidoc to install:

~~~~.bash

asciidoc --backend install deckjs-X.Y.Z.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:

~~~~.bash

asciidoc -b deckjs file.asciidoc

~~~~

By default, the `linkcss` option is disabled so all the required js and css

file will be embedded into the output slide. Checkout the [template file][example]

for how to enable all kinds of options.

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

~~~~.bash

asciidoc -f deckjs.conf file.asciidoc

~~~~

Make sure your asciidoc can properly find `deckjs.conf`. For asciidoc's configuration file loading strategy, please refer to [this guide][asc-conf-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.

[deckjs]:https://github.com/houqp/asciidoc-deckjs/releases

[deckjs-ext]:https://github.com/houqp/asciidoc-deckjs/releases/download/v1.6.3/deck.js.extended.zip

[asc-conf-guide]:http://www.methods.co.nz/asciidoc/userguide.html#X27

[example]:http://houqp.github.com/asciidoc-deckjs/example-template.asciidoc