https://github.com/miska/my-deckjs-for-asciidoc

Upstream deckjs plugin for asciidoc together with some usefull extensions and some small modifications to fit my purpose
https://github.com/miska/my-deckjs-for-asciidoc

Last synced: 1 day ago
JSON representation

Upstream deckjs plugin for asciidoc together with some usefull extensions and some small modifications to fit my purpose

• Host: GitHub
• URL: https://github.com/miska/my-deckjs-for-asciidoc
• Owner: miska
• License: gpl-2.0
• Created: 2013-06-13T07:28:27.000Z (over 11 years ago)
• Default Branch: master
• Last Pushed: 2013-07-04T08:49:41.000Z (over 11 years ago)
• Last Synced: 2024-12-06T06:59:17.866Z (about 1 month ago)
• Language: JavaScript
• Size: 254 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

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

Clone this repo to `~/.asciidoc/backends/deckjs`

~~~~.bash

mkdir -p ~/.asciidoc/backends

cd ~/.asciidoc/backends

git clone https://github.com/miska/my-deckjs-for-asciidoc.git 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/downloads

[deckjs-ext]:https://github.com/downloads/houqp/asciidoc-deckjs/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