Transform a flat markdown to a reveal.js presentation.
Project description
mdtoreveal
It's an extremly basic Markdown to reveal.js conversion tool.
Yes reveal already supports Markdown, but it needs specifically crafted Markdown with strange separators which I don't personally like. And yes you can also do this using pandoc but it mess with syntax highlighting by handling it.
Usage
mdtoreveal my_prez.md --output my_prez.html
It's also allowed to skip the output file, so its name is guessed, the previous command is equivalent to the following one:
mdtoreveal my_prez.md
Syntax
Let's start with pure Markdown:
# Big titles makes reveal.js "columns"
## Sub titles make reveal.js "slides" inside columns.
```python
print("Syntax highlighting works")
```
::: notes
Look, this is a personal note, it's not mandatory to use them, but you still can.
Everything betwen `::: notes` and the next slide is only visible by the presenter.
## 2nd slide
Blah blah …
Example
It converts this into this (this one uses a .gitlab-ci.yml to publish on push).
Configuration
There's not, deal with it, don't loose your time on fine-tuning, and focus on your presentation.
Still, you prefer a dark theme? It's unreadable on video projectors, keep this one, trust me.
You want bigger code blocks? You already have 12 lines and 61 columns, if you stuff more, it won't be readable anyway, stick to it.
You want a bigger font for your code blocks, so it's still readable from the end of the room? I can understand that, I used to use a bigger one too, let's talk in the issues.
You're using a Makefile?
Me too ♥ this should do:
SRCS := $(wildcard *.md)
HTML := $(SRCS:.md=.html)
.PHONY: static
static: $(HTML)
%.html: %.md
mdtoreveal $< -o $@
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
Built Distribution
File details
Details for the file mdtoreveal-0.3.3.tar.gz
.
File metadata
- Download URL: mdtoreveal-0.3.3.tar.gz
- Upload date:
- Size: 5.1 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.2 CPython/3.10.9
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | dd719288c382e97bee69747df875af476596c9abfedb82a0bad455aa646a40b7 |
|
MD5 | 376b5dd5ab32c70b1306d8e3dae10a59 |
|
BLAKE2b-256 | 640525ef454b9e802627058e4b1e95d9510e529d29ba121346c29be04b734dcb |
File details
Details for the file mdtoreveal-0.3.3-py3-none-any.whl
.
File metadata
- Download URL: mdtoreveal-0.3.3-py3-none-any.whl
- Upload date:
- Size: 5.3 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.2 CPython/3.10.9
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 514690a8981bb552a1a31025327ae857215db141288b273467134e6a068bb7d5 |
|
MD5 | 292841bc8cafc1a69b2bb8d1e8059b01 |
|
BLAKE2b-256 | 440389368ba04625557fcb996f39ec461638b61add978907f89cf40e33e38dd9 |