Commit c5cf5059 authored by Henrik Tramberend's avatar Henrik Tramberend
Browse files

Update readme.md

parent 62eb95ed
...@@ -9,9 +9,9 @@ directory and all subdirectories. Markdown files ending on `.md` in those ...@@ -9,9 +9,9 @@ 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 directories are processed and converted to either a reveal.js slide show, a HTML
document, or a PDF document, depending on the file name. document, or a PDF document, depending on the file name.
`*-deck.md` - `*-deck.md`
: Files with this ending are processed as silde decks. From one source file Files with this ending are processed as silde decks. From one source file
potentially four different targets can be generated: potentially four different targets can be generated:
- `*-deck.html` A reveal.js based slide show - `*-deck.html` A reveal.js based slide show
...@@ -20,39 +20,45 @@ document, or a PDF document, depending on the file name. ...@@ -20,39 +20,45 @@ document, or a PDF document, depending on the file name.
- `*-deck.pdf` A PDF version of the slide show - `*-deck.pdf` A PDF version of the slide show
- `*-handout.pdf` A PDF version of the handout - `*-handout.pdf` A PDF version of the handout
`*-page.md` - `*-page.md`
: Markdown files ending on `*-page.md` are translated into corresponding HTML Markdown files ending on `*-page.md` are translated into corresponding HTML
or PDF documents. or PDF documents.
## *decker* targets ## *decker* targets
decker help - `decker help`
: Prints this document to stdout in Markdown format.
decker html Prints this document to stdout in Markdown format.
: Builds HTML versions of all available documents.
decker pdf - `decker html`
: Builds PDF versions of all documents that are generated from
Builds HTML versions of all available documents.
- `decker pdf`
Builds PDF versions of all documents that are generated from
`*-deck.md` files. `*-deck.md` files.
decker pdf-decks - `decker pdf-decks`
: Builds PDF versions of all slide decks.
Builds PDF versions of all slide decks (requires `decktape.sh`).
decker watch - decker watch
: Builds HTML versions of all documents and then watches for document changes.
Builds HTML versions of all documents and then watches for document changes.
Each change to a watched document triggers a rebuild. Watching can be Each change to a watched document triggers a rebuild. Watching can be
terminated with `^C`. terminated with `^C`.
decker server - decker server
: Like `decker watch`. Additionally a local web server is started that serves
Like `decker watch`. Additionally a local web server is started that serves
the generated HTML files. The `index.html` document is automatically openend the generated HTML files. The `index.html` document is automatically openend
in the browser. Changed files are automatically reloaded in the browser. in the browser. Changed files are automatically reloaded in the browser.
(requires `livereloadx`)
decker example - decker example
: Write a few example files to the current directory. To start exploring decker Write a few example files to the current directory. To start exploring decker
type type
``` {.bash} ``` {.bash}
...@@ -63,12 +69,13 @@ decker example ...@@ -63,12 +69,13 @@ decker example
and make some changes to the Markdown files. `example-deck.md` contains the 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. source code for a slide deck that explains most of the features supported.
decker clean - decker clean
: Recursively removes all generated files from the current directory.
Recursively removes all generated files from the current directory.
decker check - decker check
: Check for all required external depencies. If one of the programs is missing, Check for all required external depencies. If one of the programs is missing,
an error is generated. Required programs include: an error is generated. Required programs include:
- `pdflatex` as part of a complete LaTeX installation - `pdflatex` as part of a complete LaTeX installation
...@@ -76,24 +83,19 @@ decker check ...@@ -76,24 +83,19 @@ decker check
- `livereloadx` as live-reloading local webserver - `livereloadx` as live-reloading local webserver
- `rsync` to publish the documents to a remote location - `rsync` to publish the documents to a remote location
decker plan - decker plan
: Prints a list of all source files found below the current directory.
decker meta Prints a list of all source files found below the current directory.
: Pretty prints all meta data that can be found in `*.yaml` files in the
- 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 current directory and below. Meta data is mainly used to perform
substitutions in Markdown documents using the Mustache templating system. substitutions in Markdown documents using the Mustache templating system.
decker publish - decker publish
: Publish the generated files to a remote location using `rsync` if the
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 location is specified in the meta data. The keys `rsync-destination.host` and
`rsync-destination.path` specify the publishing destination. `rsync-destination.path` specify the publishing destination.
decker clean-cache
: Remove all cached image files. Subsequent document builds will use the
original remote images.
## Installation
## Development
Build completed in 0:01m
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment