A tool for generating slides from markdown files using different backends.
Project description
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 simple.md,
---
title : Example Presentation
---
# First Slide
Text
# Second Slide
$\nabla \cdot \vec{E} = \frac{\rho}{\epsilon_0}$
and running mdSlides
on it
$ mdSlides simple.md
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.
Installing
You can install mdSlides with pip
pip install mdSlides
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file mdslides-0.1.2.tar.gz
.
File metadata
- Download URL: mdslides-0.1.2.tar.gz
- Upload date:
- Size: 2.4 MB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.1.1 CPython/3.12.5
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | fcfc34b1479643e8f3734461df52c2d0da5f828f812748e1457c0f9ff8d96dcb |
|
MD5 | 2097e54628f248762ec1f8b0d0807af2 |
|
BLAKE2b-256 | 8097519eed35b7e2b543d31f004bbc6d4b5aa3a021bcb06d5cb1cf509ddd7c13 |
File details
Details for the file mdslides-0.1.2-py3-none-any.whl
.
File metadata
- Download URL: mdslides-0.1.2-py3-none-any.whl
- Upload date:
- Size: 5.5 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.1.1 CPython/3.12.5
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 0fdc4d2c80483a1b2c916d55a4127d2cccbcdd30bb55b817046ac0c885a1fc4d |
|
MD5 | 2d2661006386625fbdce068063200030 |
|
BLAKE2b-256 | c8fe833e34df2756fe42fffcb85f61f6dcae50b10a6f2662b3db6a28f017c47b |