Skip to main content

A tool for generating slides from markdown files using different backends.

Project description


mdSlides is a small utility for creating slideshows from markdown files. It is a wrapper around other tools that actually generate the slides (currently only Pandoc) and handles setting up and passing the correct command options to each tool.

Given a small Pandoc markdown file named,

title  : Example Presentation

# First Slide


# Second Slide

$\nabla \cdot \vec{E} = \frac{\rho}{\epsilon_0}$

and running mdSlides on it

$ mdSlides

will produce a directory named simple that contains a file named index.html. You can open the file in a web browser to start the slide show.

mdSlides will also copy files that are needed for the slideshow, for example css files, images, etc, and configure the slideshow to use the local files so that you can copy the directory to another computer (like a web server) and it will still work.

Multiple "engines" are supported. The default engine uses Pandoc to output a slidy presentation. To see a list of supported engines, run

$ mdSlides --list-engines

Only a few engines are currently supported, but others will be added in the future.


You can install mdSlides with pip

pip install mdSlides

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

mdslides-0.0.6.tar.gz (6.2 kB view hashes)

Uploaded Source

Built Distribution

mdslides-0.0.6-py3-none-any.whl (5.7 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page