Markdown Slides

What is it?

A template project for a Github page

• to quickly create beautiful slides
• and share them on freely hosted Github pages
• it is based primarily on Markdown → easy collaboration and version control
• you can host multiple presentations
• to see its full power, just check the getting started presentation

It is powered by reveal.js, an awesome project by Hakim El Hattab and based on and inspired by reveal-jekyll by Thomas Friese

How to set up and use it?

Check out the introduction slides to see how to use this repo!

You can set up the project both locally and hosted on Github Pages.

Github Pages

Just fork the project, and rename your main branch to gh-pages.

That's it :)

Locally

Clone the project including submodules using

git clone --recursive https://github.com/a-nau/markdownslides.git

The you can either install Jekyll and run it or use the provided Docker image.

We recommend using the Docker image by following these steps:

• Install Docker if you haven't already
• Build the Docker image using docker build -t jekyll .
• Run markdownslides with docker run -v ${PWD}:/app -p 4000:4000 -it --rm --name markdownslides jekyll
• Reach the website under http://localhost:4000/markdownslides/

For more information, also check out this blog post.

What can it do?

Check the examples!

Licenses

• Jekyll: MIT licensed
• reveal.js: MIT licensed, Copyright (C) 2016 Hakim El Hattab, http://hakim.se
• reveal-jekyll: MIT licensed, Copyright (C) 2016 Thomas Friese, http://tasmo.rocks
• Github CSS Ribbon: MIT licensed, Copyright (c) 2013 Simon Whitaker

Easy Markdown Slides: MIT licensed, Copyright (C) 2021 Alexander Naumann, https://a-nau.github.io