Skip to main content

Transform a flat markdown to a reveal.js presentation.

Project description

md2reveal

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

md2reveal 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:

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

Uploaded Source

Built Distribution

mdtoreveal-0.1-py3-none-any.whl (5.1 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: mdtoreveal-0.1.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.1.tar.gz
Algorithm Hash digest
SHA256 e7b7aceb5b05474ff2bce2b3f5bd15be04729421cb5d2fa8a6fcf6c16b8879f8
MD5 9fe36cc665c419a71144c9e750ac0153
BLAKE2b-256 92603dffe0c4c03cc57ded4a5e09b1a13cdc28441680f8d8eee0ca4388790f96

See more details on using hashes here.

File details

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

File metadata

  • Download URL: mdtoreveal-0.1-py3-none-any.whl
  • Upload date:
  • Size: 5.1 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.1-py3-none-any.whl
Algorithm Hash digest
SHA256 880c6a15162cd7156898c0fba6bc04078274592c465068c5986551e322897b4f
MD5 14751cfde2a59d9a9052cb7ede0dd9b9
BLAKE2b-256 87cfce2cfb696d0589a250e1e4b25c70849c50dc66f813a66740eacd59524d27

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