Commit 584da09b authored by Henrik Tramberend's avatar Henrik Tramberend
Browse files

Update readme.md

parent c5cf5059
...@@ -36,6 +36,7 @@ document, or a PDF document, depending on the file name. ...@@ -36,6 +36,7 @@ document, or a PDF document, depending on the file name.
Builds HTML versions of all available documents. Builds HTML versions of all available documents.
- `decker pdf` - `decker pdf`
Builds PDF versions of all documents that are generated from Builds PDF versions of all documents that are generated from
`*-deck.md` files. `*-deck.md` files.
...@@ -43,20 +44,20 @@ document, or a PDF document, depending on the file name. ...@@ -43,20 +44,20 @@ document, or a PDF document, depending on the file name.
Builds PDF versions of all slide decks (requires `decktape.sh`). 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`) (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
...@@ -69,11 +70,11 @@ document, or a PDF document, depending on the file name. ...@@ -69,11 +70,11 @@ document, or a PDF document, depending on the file name.
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:
...@@ -83,17 +84,17 @@ document, or a PDF document, depending on the file name. ...@@ -83,17 +84,17 @@ document, or a PDF document, depending on the file name.
- `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. Prints a list of all source files found below the current directory.
- decker meta - `decker meta`
Pretty prints all meta data that can be found in `*.yaml` files in the 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
......
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