oxoaresearch / markdeck

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

markdeck - presentations as code

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

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:
  see the slide source and the result, side-by-side

You can also visit the shiny landing page or the showcase.

install markdeck, tl;dr

You need bash, curl, docker-compose and an empty directory, then run the following command:

curl https://raw.githubusercontent.com/arnehilmann/markdeck/master/scaffold | bash

This will download a minimal setup, download all needed docker images, then markdeck gets started...

Use Ctrl-C to stop markdeck, and ./start, ./stop or ./update-markdeck to do the suitable things.

documentation

... can be found in DOCUMENTATION.md

how to start from scratch

mkdir my-slides && cd my-slides
curl -O https://raw.githubusercontent.com/arnehilmann/markdeck/master/scaffold
./scaffold

open 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 as converter and reveal.js as the presenter framework.

see the side-by-side view, to get an idea how markdeck works and looks like, or have a look at the documentation.

based on

markdown, pandoc, reveal.js, plantuml, ditaamini, asciitosvg, graphviz, asciinema, decktape, vega-lite, mathjax-pandoc-filter, and font-awesome.

known issues

• custom layout hard, but possible
• pixel-perfect layout nearly impossible
• see the todos

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/