Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/arnehilmann/markdeck

presentations as code - author cool slide decks, text-only, offline-ready, collaborative
https://github.com/arnehilmann/markdeck

ascii-art asciinema decktape ditaa graphviz markdown markdown-to-html mathjax pandoc pandoc-filter plantuml presentation revealjs slide-deck vega-lite

Last synced: 11 days ago
JSON representation

presentations as code - author cool slide decks, text-only, offline-ready, collaborative

Awesome Lists containing this project

README 

        
# markdeck - presentations as code



author cool slide decks, text-only, offline-ready, collaborative



![](https://img.shields.io/github/forks/arnehilmann/markdeck.svg)

![](https://img.shields.io/github/stars/arnehilmann/markdeck.svg)

![](https://img.shields.io/github/issues/arnehilmann/markdeck.svg)

![](https://img.shields.io/github/license/arnehilmann/markdeck.svg)

[![Donate](https://img.shields.io/badge/Donate-PayPal-green.svg)](https://paypal.me/ArneHilmann)



## why?



* converts markdown to a clean html5 slide deck

* cool looking: based on battle-proven web frameworks, like reveal.js

* no uplink required, neither when authoring, nor presenting:

    no awkward moments during presentation (no "I am still waiting for the Internet, sorry!")

* all batteries included: live renderer, pdf output, asciiart-converter

* text-only, easy syntax: just markdown

* fast-n-easy to write: bring your own editor!

* easy to collaborate-n-reuse: text-only, so bring your own VCS

* eye-candy: supports unicode, emojis, fontawesome, asciiart, math, charts, code highlighting,

    recorded terminal sessions, ...

* self-documenting [documentation slides](DOCUMENTATION.md#self-documenting-documentation-slides):

    see the slide source and the result, side-by-side



You can also visit the shiny [landing page](https://arnehilmann.github.io/markdeck/), the

[revealjs showcase](https://arnehilmann.github.io/markdeck/showcase/), or the

[impressjs showcase](https://arnehilmann.github.io/markdeck/showcase.impress/).



## install markdeck, tl;dr



You need `bash`, `curl`, and `docker-compose`, then run the following commands:

```

curl -LO https://raw.githubusercontent.com/arnehilmann/markdeck/master/markdeck

chmod a+x markdeck

./markdeck pull

```



The `markdeck` script can be stored in a folder in `$PATH` so that it

can be executed from everywhere in the file system.



## documentation



... can be found in [DOCUMENTATION.md](DOCUMENTATION.md)



## how to start from scratch



Run the following command to create an empty presentation (if markdeck

is not stored in `$PATH` prefix the command with `./`):



```

markdeck scaffold

```



Run the following command to start markdeck:



```

markdeck

```



Open the browser at `http://localhost:8080`.



# edit slides.md, add assets/, consult documentation, ...



## how does this work



*markdeck* takes ```slide-*.md``` files in markdown format

and the assets subdir

and renders a html5 slidedeck, using [pandoc](http://pandoc.org) as converter

and [reveal.js](http://lab.hakim.se/reveal-js/) as the presenter framework.



see the

[side-by-side view](https://arnehilmann.github.io/markdeck/showcase/explain.html),

to get an idea how markdeck works and looks like, or have a look

at the [documentation](DOCUMENTATION.md).



## based on



[markdown](https://daringfireball.net/projects/markdown/syntax),

[pandoc](https://pandoc.org/),

[reveal.js](https://revealjs.com/#/),

[plantuml](http://wiki.plantuml.net/site/index),

[ditaamini](http://ditaa.sourceforge.net/),

[asciitosvg](https://github.com/dhobsd/asciitosvg),

[graphviz](https://www.graphviz.org/),

[asciinema](https://asciinema.org/),

[decktape](https://github.com/astefanutti/decktape),

[vega-lite](https://vega.github.io/vega-lite/),

[mathjax-pandoc-filter](https://www.npmjs.com/package/mathjax-pandoc-filter), and

[font-awesome](https://fontawesome.com/).



## known issues



* custom layout hard, but possible

* pixel-perfect layout nearly impossible

* see the [todos](TODOS.md)



## similar projects



* http://bigsense.github.io/

* http://slideshow-s9.github.io

* https://github.com/FormidableLabs/spectacle

* https://github.com/divshot/markdeck

* https://github.com/jxnblk/mdx-deck

* https://github.com/munen/p_slides

* https://github.com/regebro/hovercraft

* https://github.com/sinedied/backslide

* https://gitpitch.com/

* https://godoc.org/golang.org/x/tools/cmd/present

* https://www.deckset.com/

* https://yhatt.github.io/marp/