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 …

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.tar.gz (5.0 kB view details)

Uploaded Source

Built Distribution

mdtoreveal-0.3-py3-none-any.whl (7.8 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: mdtoreveal-0.3.tar.gz
  • Upload date:
  • Size: 5.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.6.1 requests/2.25.0 setuptools/49.2.1 requests-toolbelt/0.9.1 tqdm/4.54.0 CPython/3.9.0

File hashes

Hashes for mdtoreveal-0.3.tar.gz
Algorithm Hash digest
SHA256 2b4b4c030dbe12839618144f06d0e5d445960a77a82b2b72c741a87667abf496
MD5 f7b23deafe612ee000dfa220cbfa20de
BLAKE2b-256 7e1e188b54b3f43fb5c7d1a0b06a54fa77fc741b36657b47d9fe2cb3fee8a646

See more details on using hashes here.

File details

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

File metadata

  • Download URL: mdtoreveal-0.3-py3-none-any.whl
  • Upload date:
  • Size: 7.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.6.1 requests/2.25.0 setuptools/49.2.1 requests-toolbelt/0.9.1 tqdm/4.54.0 CPython/3.9.0

File hashes

Hashes for mdtoreveal-0.3-py3-none-any.whl
Algorithm Hash digest
SHA256 b864bbea654b385ccc3e94c75cad000c6f917d5d856886c09d9ac4d6d384bb88
MD5 ac77feb9f22ad1e7e8ffaad130831e77
BLAKE2b-256 983bc92a811c9b64b3dfbc101d6cbe69172cfa962dc3559e8c7ace66201111e2

See more details on using hashes here.

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