tmdpres

A Tiny Markdown presentation generator. It is designed to convert markdown files to html presentations.

Dependencies

Instalation

To install tmdpres you can edit the Makefile to match your local setup (tmdpres is installed into the /usr/local/bin by default).

Afterwards enter the following command to install tmdpres (if necessary as root).

sudo make install

To uninstall tmdpres:

sudo make uninstall

Syntax

You should write your markdown presentation by separating the slides with ---.

And can also add yaml metadata to the file by adding then as an html comment (to be hidden in the html file). By now tmdpres just interprets title metadata.

Example:

<!--
title: "Hello World"
author: Edimar Calebe Castanho
date: 2021-05-01
time: 14:39
-->

<center>
# This is an example
</center>

---

## First!

* Some list items
* 2
* 3

---

## Another slide

* Thats it!

Operation

The tmdpres was designed to be a single file markdown presentation creator. It is designed to be as simple as possible. The script converts your markdown presentation to html using pandoc. It then splits the result html file into slides and surround every slide into a <div class="slide"> tag using a built-in python script. After this process tmdpres then creates your presentation by contatenating the your converted markdown with the built-in _header and _footer.html. Also tmdpres uses spcss as CSS style.

Customization

You can change the layout of the slides by changing the _header.html and _footer.html inside the tmdpres script.

Usage

To create your presentation just run the following command:

$ tmdpres presentation.md

The presentation output will be presentation.html.

Team


Edimar Calebe Castanho (Calebe94)	Gabriel Gaboardi (Gabo)

License

All software is covered under GNU General Public License v3.0.