Skip to main content

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

mdtoreveal-0.3.1.tar.gz (5.0 kB view details)

Uploaded Source

Built Distribution

mdtoreveal-0.3.1-py3-none-any.whl (5.3 kB view details)

Uploaded Python 3

File details

Details for the file mdtoreveal-0.3.1.tar.gz.

File metadata

  • Download URL: mdtoreveal-0.3.1.tar.gz
  • Upload date:
  • Size: 5.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/4.3.1 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.61.0 CPython/3.9.4

File hashes

Hashes for mdtoreveal-0.3.1.tar.gz
Algorithm Hash digest
SHA256 503af13854ffebd58ad86969155836bb7465994ca9932210f17cddf7c1a3f4f0
MD5 862d8c5eb5e1b213940e8bd86033d34d
BLAKE2b-256 f1c6178ac37d905b37d474a4685b1e2e96f365f06cf8d2555e7a7e76963fe500

See more details on using hashes here.

Provenance

File details

Details for the file mdtoreveal-0.3.1-py3-none-any.whl.

File metadata

  • Download URL: mdtoreveal-0.3.1-py3-none-any.whl
  • Upload date:
  • Size: 5.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/4.3.1 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.61.0 CPython/3.9.4

File hashes

Hashes for mdtoreveal-0.3.1-py3-none-any.whl
Algorithm Hash digest
SHA256 4f514b3082d8c4b011194a7a9493596d2ae70eb034eaa85a612e006f0dae5336
MD5 8d6061012702d21bb0f68c888f45d6c6
BLAKE2b-256 e118525517b475326568f328a9fda5fe480c0a8eabb3dfa711d62d57f0ba0b3f

See more details on using hashes here.

Provenance

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