Skip to content

Latest commit

 

History

History
40 lines (28 loc) · 1.6 KB

README.markdown

File metadata and controls

40 lines (28 loc) · 1.6 KB

Markdown to deck.js slides

This is my personal utility for writing presentation slides using markdown and generating deck.js slides.

Requirements

Pandoc is used to convert markdown to HTML and needs to be installed. For installation see here.

The makefile used to generate the HTML documents requires GNU Make

Included components

A few other libraries are included to make this work:

Usage

  1. Write a markdown file, it should use Pandoc's slideshow format. See example.md for an example.
  2. Run make <filename without suffix>, for example make example. Just running make compiles all *.md files as presentations
  3. Open the generated markdown file, for eample example.html

Interesting things

  • The base for generating the slides is Pandoc's dzslides mode, but the templates are overridden to use deck.js instead. The templates can be found in the data directory.
  • CodeMirror modes are automatically loaded. The document reads all CodeMirror-enabled blocks and loads the required modes.
  • It's possible to customize themes and data, see the Makefile and the files in the data directory for examples