Commit 79fab6fe authored by Armin Bernstetter's avatar Armin Bernstetter

updated readme and some other files

parent f90eacf3
......@@ -90,14 +90,26 @@ Exchange the `html` at the end of the command with your *decker* command of choi
## *decker* targets
- `decker version`
Prints the current decker version and branch as well as the current pandoc version.
- `decker help`
Prints a help document to stdout in Markdown format.
- `decker info`
Prints information about the current project's directories, the targets (files which will be generated) and the meta data options which are found in top level `*-meta.yaml` files.
- `decker html`
Builds HTML versions of all available documents.
- `decker decks`
Builds only HTML slide decks.
- `decker pdf`
Builds PDF versions of all documents.
......@@ -107,7 +119,7 @@ Exchange the `html` at the end of the command with your *decker* command of choi
Builds PDF versions of all slide decks.
To use `decker pdf` or `decker pdf-decks`, Google Chrome has to be installed.
**Windows:** Currently `decker pdf` does not work on Windows. Please add `print: true` or `menu: true` to your slide deck and use the print button on the title slide.
**Windows:** Currently `decker pdf` does not work on Windows. Please add `print: true` or `menu: true` to your slide deck and use the print button in the menu or on the title slide.
**MacOS:** Follow the Google Chrome installer instructions. **Google Chrome.app** has to be located in either `/Applications/Google Chrome.app` or `/Users/username/Applications/Google Chrome.app`
Alternatively you can add `chrome` to `$PATH`.
**Linux:** `chrome` has to be on `$PATH`.
......@@ -135,22 +147,16 @@ Exchange the `html` at the end of the command with your *decker* command of choi
```
and make some changes to the Markdown files. `example-deck.md` contains the
source code for a slide deck that is supposed to (someday) explain most of
the features supported.
- `decker clean`
source code for a slide deck that explains most of the available features for creating slide decks.
Recursively removes all generated files from the current directory.
- `decker tutorial`
- `decker plan`
Like `example` but copies extended example/tutorial slide decks to the current directory.
Prints a list of all source files found below the current directory.
- `decker meta`
- `decker clean`
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.
Recursively removes all generated files from the current directory (i.e. the `public` folder).
Also removes cached resources witch version number lower than the current version.
- `decker publish`
......
......@@ -378,6 +378,9 @@ Video with controls:
Video with autoplay:
![](movies/jmu-hci-intro.mp4){data-autoplay=true}
Start video at timestamp:
![](movies/jmu-hci-intro.mp4){data-autoplay=true start="10"}
```
## {.split}
......
......@@ -22,6 +22,10 @@ The general recommended workflow of decker on the command line is:
Prints a help document to stdout in Markdown format.
# `decker info`
Prints information about the current project's directories, the targets (files which will be generated) and the meta data options which are found in top level `*-meta.yaml` files.
# `decker example` and `decker tutorial`
- `decker example` copies an example project to the current directory
......@@ -33,9 +37,10 @@ Prints a help document to stdout in Markdown format.
- `decker server`: Like `decker watch`. Additionally a local web server at the address `localhost:8888` is started that serves the generated HTML files. Changed files are reloaded in the browser.
# `decker html`
# `decker html` and `decker decks`
`decker html` creates all HTML files without opening a server
- `decker html` creates all HTML files without opening a server
- `decker decks`creates only HTML slide decks
# `decker clean`
......@@ -56,11 +61,6 @@ Alternatively you can add `chrome` to `$PATH`.
- **Linux:** `chrome` has to be on `$PATH`.
# `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.
......
......@@ -378,6 +378,9 @@ Video with controls:
Video with autoplay:
![](movies/jmu-hci-intro.mp4){data-autoplay=true}
Start video at timestamp:
![](movies/jmu-hci-intro.mp4){data-autoplay=true start="10"}
```
## {.split}
......
date: 2019-04-18
date: 2019-04-23
menu: true
\ No newline at end of file
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