Takes markdown and turns it into an html slideshow.
Project description
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.6
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
The markdown-to-presentation push executable takes the following arguments:
$ markdown-to-presentation push --help
usage: markdown-to-presentation push [-h] [--master-branch MASTER_BRANCH]
[--pages-branch PAGES_BRANCH]
paths [paths ...]
positional arguments:
paths
optional arguments:
-h, --help show this help message and exit
--master-branch MASTER_BRANCH
--pages-branch PAGES_BRANCH
Release history Release notifications | RSS feed
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 markdown_to_presentation-0.0.32.tar.gz.
File metadata
- Download URL: markdown_to_presentation-0.0.32.tar.gz
- Upload date:
- Size: 7.6 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.2.0 pkginfo/1.6.1 requests/2.25.0 setuptools/50.3.2 requests-toolbelt/0.9.1 tqdm/4.54.0 CPython/3.8.5
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | e62d09c67810f65c5ad1367d4fa8de0f17962ebe4fd19505d4bf41cf34a10b81 |
|
| MD5 | c65f6320c0b64556aacdeedacf50a3d2 |
|
| BLAKE2b-256 | 1220731a0e989594aaeb478e1b8eb73651b0da2feac887ed3e78961f4e38e776 |
Provenance
File details
Details for the file markdown_to_presentation-0.0.32-py2.py3-none-any.whl.
File metadata
- Download URL: markdown_to_presentation-0.0.32-py2.py3-none-any.whl
- Upload date:
- Size: 7.8 kB
- Tags: Python 2, Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.2.0 pkginfo/1.6.1 requests/2.25.0 setuptools/50.3.2 requests-toolbelt/0.9.1 tqdm/4.54.0 CPython/3.8.5
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | f5f12bdd68ff53bb900044de6c28f0b437cffb59c207f73a477917f11f67dfeb |
|
| MD5 | b5e1685cbafb72f93c2dc670ebfa359c |
|
| BLAKE2b-256 | 2301e11770a723be0c67d036337c7f424009662fc5b170cf6acdab3e730a0334 |
