readme.md 4.82 KB
Newer Older
Henrik Tramberend's avatar
Henrik Tramberend committed
1 2 3 4
# decker

A markdown based tool for slide deck creation.

5 6
## Installation

7
Pick a [published
Henrik Tramberend's avatar
Again  
Henrik Tramberend committed
8
release](../../releases), download and
9
unpack:
10

11
``` {.sh}
12 13 14 15 16 17
gunzip decker.gz
chmod a+x decker
```

## Installation from source

18 19
1.  Install [stack](https://docs.haskellstack.org/en/stable/README/).
2.  Clone this repo.
Henrik Tramberend's avatar
Henrik Tramberend committed
20
3.  `cd decker`
21
4.  `make install`
22

Henrik Tramberend's avatar
Henrik Tramberend committed
23 24 25 26
## External tools

Decker uses a few external tools that need to be installed on the system:

27
-   [*ssh*](https://www.openssh.com) for publishing slide decks and resources
28 29 30 31 32 33 34 35 36 37 38 39
-   [*rsync*](http://formulae.brew.sh/repos/Homebrew/homebrew-core/formula/rsync)
    for publishing slide decks and resources
-   [*unzip*](http://formulae.brew.sh/repos/Homebrew/homebrew-core/formula/unzip)
    to extract resources from the decker executable
-   [*decktape*](https://github.com/astefanutti/decktape) to convert HTML slide
    decks to PDF format
-   [*LaTeX* with pdflatex](https://www.latex-project.org) to generate LaTeX in
    PDF-files and embedded Tikz figures
-   [*Graphviz*](http://graphviz.org) to generate graphs using `dot`
-   [*Gnuplot*](http://gnuplot.sourceforge.net) to generate graphs using `dot`
-   [*pdf2svg*](https://github.com/dawbarton/pdf2svg) to generate SVG files from
    PDF documents
40
-   [*sassc*](https://github.com/sass/sassc) to compile SCSS to CSS
41 42 43 44 45 46

### Installation of external tools on macOS

Use [Homebrew](https://brew.sh) to install most of them.

``` {.sh}
47
brew install rsync unzip graphviz gnuplot pdf2svg sassc
48 49 50 51
```

For the rest follow instructions on their respective webites.

Henrik Tramberend's avatar
Henrik Tramberend committed
52 53
## Usage

54 55 56 57
*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.
Henrik Tramberend's avatar
Henrik Tramberend committed
58

Henrik Tramberend's avatar
Henrik Tramberend committed
59
-   `*-deck.md`
Henrik Tramberend's avatar
Henrik Tramberend committed
60

61 62
    Files with this ending are processed as silde decks. From one source file
    potentially four different targets can be generated:
Henrik Tramberend's avatar
Henrik Tramberend committed
63 64

    -   `*-deck.html` A reveal.js based slide show
65 66
    -   `*-handout.hmtl` A HTML document containing the speaker notes to the
        slide show.
Henrik Tramberend's avatar
Henrik Tramberend committed
67 68 69
    -   `*-deck.pdf` A PDF version of the slide show
    -   `*-handout.pdf` A PDF version of the handout

Henrik Tramberend's avatar
Henrik Tramberend committed
70
-   `*-page.md`
Henrik Tramberend's avatar
Henrik Tramberend committed
71

72 73
    Markdown files ending on `*-page.md` are translated into corresponding HTML
    or PDF documents.
Henrik Tramberend's avatar
Henrik Tramberend committed
74 75 76

## *decker* targets

Henrik Tramberend's avatar
Henrik Tramberend committed
77
-   `decker help`
Henrik Tramberend's avatar
Henrik Tramberend committed
78

Henrik Tramberend's avatar
Henrik Tramberend committed
79
    Prints a help document to stdout in Markdown format.
Henrik Tramberend's avatar
Henrik Tramberend committed
80

Henrik Tramberend's avatar
Henrik Tramberend committed
81 82 83 84 85
-   `decker html`

    Builds HTML versions of all available documents.

-   `decker pdf`
Henrik Tramberend's avatar
Henrik Tramberend committed
86

87 88
    Builds PDF versions of all documents that are generated from `*-page.md`
    files.
Henrik Tramberend's avatar
Henrik Tramberend committed
89

Henrik Tramberend's avatar
Henrik Tramberend committed
90 91 92
-   `decker pdf-decks`

    Builds PDF versions of all slide decks (requires `decktape.sh`).
Henrik Tramberend's avatar
Henrik Tramberend committed
93

Henrik Tramberend's avatar
Henrik Tramberend committed
94
-   `decker watch`
Henrik Tramberend's avatar
Henrik Tramberend committed
95

96 97 98
    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`.
Henrik Tramberend's avatar
Henrik Tramberend committed
99

Henrik Tramberend's avatar
Henrik Tramberend committed
100
-   `decker server`
Henrik Tramberend's avatar
Henrik Tramberend committed
101

102 103 104
    Like `decker watch`. Additionally a local web server is started that serves
    the generated HTML files. The `*-deck.html` file is openend in the browser.
    Changed files are reloaded in the browser. (still requires `livereloadx`)
Henrik Tramberend's avatar
Henrik Tramberend committed
105

Henrik Tramberend's avatar
Henrik Tramberend committed
106
-   `decker example`
Henrik Tramberend's avatar
Henrik Tramberend committed
107

108 109
    Write a few example files to the current directory. To start exploring
    decker type
Henrik Tramberend's avatar
Henrik Tramberend committed
110 111 112 113 114 115

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

116 117 118
    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.
Henrik Tramberend's avatar
Henrik Tramberend committed
119

Henrik Tramberend's avatar
Henrik Tramberend committed
120
-   `decker clean`
Henrik Tramberend's avatar
Henrik Tramberend committed
121 122

    Recursively removes all generated files from the current directory.
Henrik Tramberend's avatar
Henrik Tramberend committed
123

Henrik Tramberend's avatar
Henrik Tramberend committed
124
-   `decker plan`
Henrik Tramberend's avatar
Henrik Tramberend committed
125

Henrik Tramberend's avatar
Henrik Tramberend committed
126 127
    Prints a list of all source files found below the current directory.

Henrik Tramberend's avatar
Henrik Tramberend committed
128
-   `decker meta`
Henrik Tramberend's avatar
Henrik Tramberend committed
129

130 131 132
    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.
Henrik Tramberend's avatar
Henrik Tramberend committed
133

Henrik Tramberend's avatar
Henrik Tramberend committed
134
-   `decker publish`
Henrik Tramberend's avatar
Henrik Tramberend committed
135

136 137 138
    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.
Henrik Tramberend's avatar
Henrik Tramberend committed
139 140 141 142 143

## Contributions

### Pull requests

144 145
Contributions are accepted via pull requests. Before working on a feature,
please write up an issue and discuss it with the other developers.
146 147 148

### CI build checks

149 150 151
The decker repository has a GitLab CI runner configured, that builds and runs
all tests for each commit on every branch. Look at the status display for recent
run of the [CI pipelines](pipelines).
152 153 154

### Haskell source code formatting

155 156 157 158
Haskell soure code readability depends heavily on consistent formatting
conventions. With decker, formatting is automated using the excellent
[hindent]() tool. Formatting is checked for each commit that is uploaded to the
GitLab repository.