help-page.md 3.04 KB
Newer Older
1
# decker
Henrik Tramberend's avatar
Henrik Tramberend committed
2 3 4 5 6

A markdown based tool for slide deck creation.

## Usage

7
*decker* behaves very much like a build tool. It works recursively on the current directory and all subdirectories. Markdown files ending on `.md` in those directories are processed and converted to either a reveal.js slide show, a HTML document, or a PDF document, depending on the file name.
Henrik Tramberend's avatar
Henrik Tramberend committed
8 9 10

`*-deck.md`

11
:   Files with this ending are processed as silde decks. From one source file potentially four different targets can be generated:
Henrik Tramberend's avatar
Henrik Tramberend committed
12 13

    -   `*-deck.html` A reveal.js based slide show
14
    -   `*-handout.hmtl` A HTML document containing the speaker notes to the slide show.
Henrik Tramberend's avatar
Henrik Tramberend committed
15 16 17
    -   `*-deck.pdf` A PDF version of the slide show
    -   `*-handout.pdf` A PDF version of the handout

18 19 20
`*-page.md`

:   Markdown files ending on `*-page.md` are translated into corresponding HTML or PDF documents.
Henrik Tramberend's avatar
Henrik Tramberend committed
21 22 23 24 25 26 27 28 29 30

## *decker* targets

decker help
:   Prints this document to stdout in Markdown format.

decker html
:   Builds HTML versions of all available documents.

decker pdf
31
:   Builds PDF versions of all documents that are generated from `*-deck.md` files.
Henrik Tramberend's avatar
Henrik Tramberend committed
32 33 34 35 36

decker pdf-decks
:   Builds PDF versions of all slide decks.

decker watch
37
:   Builds HTML versions of all documents and then watches for document changes. Each change to a watched document triggers a rebuild. Watching can be terminated with `^C`.
Henrik Tramberend's avatar
Henrik Tramberend committed
38 39

decker server
40
:   Like `decker watch`. Additionally a local web server is started that serves the generated HTML files. The `index.html` document is automatically openend in the browser. Changed files are automatically reloaded in the browser.
Henrik Tramberend's avatar
Henrik Tramberend committed
41 42 43

decker example

44
:   Write a few example files to the current directory. To start exploring decker type
Henrik Tramberend's avatar
Henrik Tramberend committed
45 46 47 48 49 50

    ``` {.bash}
    $ decker example
    $ decker server
    ```

51
    and make some changes to the Markdown files. `example-deck.md` contains the source code for a slide deck that explains most of the features supported.
Henrik Tramberend's avatar
Henrik Tramberend committed
52 53 54 55 56 57

decker clean
:   Recursively removes all generated files from the current directory.

decker check

58
:   Check for all required external depencies. If one of the programs is missing, an error is generated. Required programs include:
Henrik Tramberend's avatar
Henrik Tramberend committed
59 60 61 62 63 64

    -   `pdflatex` as part of a complete LaTeX installation
    -   `decktape.sh` for the generation of PDF versions of slide decks
    -   `livereloadx` as live-reloading local webserver
    -   `rsync` to publish the documents to a remote location

65
decker plan
Henrik Tramberend's avatar
Henrik Tramberend committed
66 67 68
:   Prints a list of all source files found below the current directory.

decker meta
69
:   Pretty prints all meta data that can be found in `*.yaml` files in the current directory and below. Meta data is mainly used to perform substitutions in Markdown documents using the Mustache templating system.
Henrik Tramberend's avatar
Henrik Tramberend committed
70 71

decker publish
72
:   Publish the generated files to a remote location using `rsync` if the location is specified in the meta data. The keys `rsync-destination.host` and `rsync-destination.path` specify the publishing destination.
Henrik Tramberend's avatar
Henrik Tramberend committed
73 74

decker clean-cache
75
:   Remove all cached image files. Subsequent document builds will use the original remote images.
Henrik Tramberend's avatar
Henrik Tramberend committed
76 77 78 79

## Installation

## Development