README

Build slides using markdown, whilst adhering to the principles learned from the How to avoid death By PowerPoint TEDx Talk.

You can see the slides of this repository as a demo at https://hogenttin.github.io/hogent-markdown-slides/ . Play with it to see what it can do!

Basic usage

Installation

1. Install python.

2. (optional) Create a python environment. E.g. for Linux:

   python -m venv venv
   source ./venv/bin/activate

3. Install mkslides:

   pip install mkslides

How do I use this?

Edit, add or delete your markdown files in the docs directory, and run mkslides build docs/ to generate the website in the site folder. That's all to get started! 🚀

Live preview

mkslides allows you to start up a live preview, so you can instantly see how your slides look like whilst editing the markdown files.

To start a local webserver with live reloading:

mkslides serve docs/

---

Configuration

Configuration

💡 You don't have to change these files or settings if you want to keep things simple. In that case, just ignore this section.

Theme

If you want another theme, you can change the theme entries in mkslides.yml. You can use a local CSS file or an existing link to a CSS file on the internet.

Landing page

You can add a template to create a nice landing page for your course. It uses the Mustache template engine. See mkslides for more information.

mkslides options

You can add them to mkslides.yml.

reveal.js options

You can also add them to mkslides.yml.

Reveal.js plugins

You can add additional functionality using Reveal.js plugins in the plugins entries in mkslides.yml. E.g., the Mermaid plugin for drawing graphs is added in this repo as an example on how to do it.

---

Additional tools

Additional tools

💡 You don't need this if you want to keep things simple. In that case, just ignore this section. Otherwise, it's here if you want an example.

Automatic deployment

This repo automatically builds the slides and pushes them to https://hogenttin.github.io/hogent-revealmd/ whenever a commit is pushed to the main branch. This is done using using GitHub actions . You can find the workflow in the .github folder.