help-page.md 3.31 KB
Newer Older
Henrik Tramberend's avatar
Henrik Tramberend committed
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103

# decker 

A markdown based tool for slide deck creation.

## Usage

*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.

`*-deck.md`

:   Files with this ending are processed as silde decks. From one source file
    potentially four different targets can be generated:

    -   `*-deck.html` A reveal.js based slide show
    -   `*-handout.hmtl` A HTML document containing the speaker notes to the
        slide show.
    -   `*-deck.pdf` A PDF version of the slide show
    -   `*-handout.pdf` A PDF version of the handout

`*.md`
:   General Markdown files are translated into corresponding HTML or
    PDF documents.

## *decker* targets

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

decker html
:   Builds HTML versions of all available documents.

decker pdf
:   Builds PDF versions of all documents that are generated from
    `*-deck.md` files.

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

decker watch
:   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`.

decker server
:   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.

decker example
:   Write a few example files to the current directory. To start exploring
    decker type


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

    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.

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

decker check

:   Check for all required external depencies. If one of the programs is
    missing, an error is generated. Required programs include:

    -   `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

decker source
:   Prints a list of all source files found below the current directory.

decker meta
:   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.

decker publish
:   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.

decker cache
:   Remote images referenced in the Markdown documents are downloaded to a local
    cache directory. If a local copy of a remote image exists in the chache, it
    is used in all subsequent document builds.

decker clean-cache
:   Remove all cached image files. Subsequent document builds will use the
    original remote images.

## Installation

## Development