md-slide

Opinionated alternative to reveal.js – create slide decks and public handouts from MarkDown files, with a typical PowerPointish look.

I created it for some of my software development courses at the Budapest University of Technology and Economics, Department of Automation and Applied Informatics – but it might be useful for anyone else as well.

Setup

• Install Pandoc
• Install node.js
• npm install -g gulp
• npm install (inside the project folder)

Getting started

• Run gulp inside the project folder
  • If you just cloned this repo, and installed everything properly, this should open the demonstration slide show and its notes in two separate Chrome tabs
  • Check out both so you can master creating md-slide decks!
• Create .md files in the content folder
  • See demo.md as an example
• Open http://localhost:5000/[yourfile]-internal-slides.html and/or http://localhost:5000/[yourfile]-internal-notes.html in a browser.
  • Optional: set DEFAULT_CONTENT in gulpfile.js to specify which slide show should open by default
• Use the arrow keys to move between slides; your notes should scroll accordingly
• While gulp is running, editing & saving your content will cause the browser(s) to refresh, making it easy to check out your changes

Generating handouts

• Run gulp dist
• Share the contents of your dist folder online (like gh-pages 😄)

Customizations

• Edit stuff in content/common and/or in the template files (template-*-*.html)
• I recommend forking this repo, so you can version control both your stylistic changes and your actual content.

Troubleshooting

• If the script refuses to (re)generate your HTML files, deleting the .gulp-cache should do the job. Sorry about that.