markdown-to-presentation

A build tool to turn markdown into an html presentation and then publish to gh-pages

Installation

pip install markdown-to-presentation

Usage

Set up the following files:

# Theme variables for reveal.js
assets/_theme.scss

# application-specific scss
assets/_app.scss

# copied into build directory
assets/*.png

# contains slides
slides.md

Slides must be delimited by a blank line followed by *** followed by a blank line. When rendered as markdown *** will be a horizontal rule. If you need a horizontal rule in your slides, use --- or ___ instead.

Here's an example slides.md:

# Title slide
## subtitle

***

## first slide

- bullet 1
- bullet 2
- bullet 3

If you need raw html in your slides, use a special rawhtml code block:

```rawhtml
<div>this html will be <em>injected</em> directly</div>
```

A sample makefile which works well with this:

all: run-build

venv: requirements.txt
    rm -rf venv
    virtualenv venv -ppython3
    venv/bin/pip install -rrequirements.txt
    venv/bin/pre-commit install -f --install-hooks

.PHONY: run-build
run-build: venv
    venv/bin/markdown-to-presentation run-build

.PHONY: push
push: venv
    venv/bin/markdown-to-presentation push index.htm build

clean:
    rm -rf .mtp venv build index.htm

Hooking up push to github pages

Acquire a push token which has the public_repo permission.

Use travis encrypt to encrypt your push token as GH_TOKEN=.... You'll need the yaml it spits out to fill out your .travis.yml.

Make a .travis.yml which looks something like this:

install: pip install virtualenv
script: make
after_success: make push
branches:
    except:
        - gh-pages
env:
    global:
        # GH_TOKEN
        - secure: ...

For your make push target, invoke something like this:

.PHONY: push
push: venv
    venv/bin/markdown-to-presentation push index.htm build

consult the markdown-to-presentation push --help to get a full list of options.

Metadata

Release files for markdown-to-presentation 0.0.34

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for markdown-to-presentation 0.0.34
File	Size	Uploaded
markdown_to_presentation-0.0.34.tar.gz	7.1 kB	Nov 8, 2022	Details

Built distribution (wheel)

Table of built distributions (wheels) for markdown-to-presentation 0.0.34
File	Interpreter	ABI	Platform	Reset
markdown_to_presentation-0.0.34-py2.py3-none-any.whl 7.7 kB Nov 8, 2022	Python 2, Python 3	none	any	Details

Total release size: 14.8 kB

Release files / markdown_to_presentation-0.0.34.tar.gz

Download URL	markdown_to_presentation-0.0.34.tar.gz
Size	7.1 kB
Tags	Source
SHA-256 checksum How to use checksums	`3e0a0e6056334381d0a5fc26d809bff6b7456ec41fc4c0bf708be07d611cffb4`
BLAKE2b-256 checksum How to use checksums	`12b101e47c0370b4bfb02cd52b3251eef449ea80efc98a53d2296f00b5a23f6c`
Upload date	Nov 8, 2022
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/4.0.1 CPython/3.10.6`

Release files / markdown_to_presentation-0.0.34-py2.py3-none-any.whl

Download URL	markdown_to_presentation-0.0.34-py2.py3-none-any.whl
Size	7.7 kB
Tags	Python 2 Python 3
SHA-256 checksum How to use checksums	`0d2f852eceef53762a5167934c4d2d014615fbe2b0cfcde63d14e784082a72f2`
BLAKE2b-256 checksum How to use checksums	`06e02a5437325b70098a003ac0b61d49d6f18efb2094d33133be79f80a8f351a`
Upload date	Nov 8, 2022
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/4.0.1 CPython/3.10.6`