Skip to content

Using markdown, write simple but beautiful presentations with math, animations and media.

License

Notifications You must be signed in to change notification settings

siwon/markdown-slides

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

82 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

logo

Using markdown, write simple but beautiful presentations with math, animations and media, which can be visualized in a web browser even without an internet connection, or exported to PDF.

See the official git repository hosted on Gitlab or the Github mirror.

This program appropriately inserts markdown files into Reveal.js files, completely avoiding the need to edit HTML files directly.

Live demo

See for yourself: check out the live demo (and the source file presentation.md).

Installation

python -m pip install git+https://gitlab.com/da_doomer/markdown-slides.git

Usage

mdslides [-h] [--include RESOURCE] [--pdf] FILE

where

  • RESOURCE: any file or directory that should be included (e.g. a directory with pictures and videos)

  • FILE: input markdown file.

Notes:

Syntax:

You will probably only need to break slides:

# My title
A subtitle maybe

[comment]: # (!!! Comments starting with this are slide breaks)

Second slide. Easy :D

Other options are documented in the example presentation presentation.md.

If you need a quick refresher on markdown see e.g. this cheatsheet, the CommonMark reference page, or this Gfm tutorial.

You will not have to break your markdown files to use this program. Control Reveal.js' theme and options using CommonMark-compliant comments.

Everything but slide-break comments and option comments is passed to Reveal.js verbatim. Check out their documentation, especially the markdown section.

Features

Some of Reveal.js's features are:

  • LaTeX syntax.
  • Automatic animations.
  • Background videos and images.

Everything is bundled in this repository so web browsers do not need internet connection to display the presentations.

Why:

  • Markdown is simple and portable. You can write markdown in a cellphone or in a remote server.
  • You want to write equations in LaTeX.
  • PDFs have no support for videos, but HTML does.
  • PowerPoint and LibreOffice are not available in all computers, but virtually every computer has a web browser.

About

Using markdown, write simple but beautiful presentations with math, animations and media.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Python 86.8%
  • HTML 13.2%