The following text ist included from file `/resource/realtive.md`:
[\#include](/resource/relative.md)
[\#include](include/relative.md)
# Multicolumn slides
...
...
@@ -208,7 +209,9 @@ $e=mc^2$
# These are just notes {.notes}
Slides with headers that are have the `.notes` class attribute are not included in the presentation. They are only visible in the handout and probably are available as presenter notes during slide presentation.
Slides with headers that are have the `.notes` class attribute are not included
in the presentation. They are only visible in the handout and probably are
available as presenter notes during slide presentation.
# Cached Images
...
...
@@ -216,7 +219,8 @@ Slides with headers that are have the `.notes` class attribute are not included
Remote images can be cached locally
Cache directory is named `img/cached` and is located in the directory of the referencing document
Cache directory is named `img/cached` and is located in the directory of the
referencing document
`decker cache` scans for and downloads all images
...
...
@@ -224,7 +228,8 @@ Cache directory is named `img/cached` and is located in the directory of the ref
## Cached remote image

@@ -4,20 +4,26 @@ 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.
*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:
: 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.
- `*-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
`*-page.md`
: Markdown files ending on `*-page.md` are translated into corresponding HTML or PDF documents.
: Markdown files ending on `*-page.md` are translated into corresponding HTML
or PDF documents.
## *decker* targets
...
...
@@ -28,34 +34,42 @@ decker html
: Builds HTML versions of all available documents.
decker pdf
: Builds PDF versions of all documents that are generated from `*-deck.md` files.
: 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`.
: 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.
: 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
: 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.
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:
: 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
...
...
@@ -66,13 +80,18 @@ decker plan
: 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.
: 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.
: 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 clean-cache
: Remove all cached image files. Subsequent document builds will use the original remote images.
: Remove all cached image files. Subsequent document builds will use the