Miniprez is a command-line tool that turns special markup into slides.
Create a file called
hello.md with the following examples to follow along.
miniprez hello.md to create a file named
hello.html in your web-browser and make sure to refresh each time you re-compile your slides!
pip install git+git://github.com/thoppe/miniprez.git
miniprez is a command-line utility. If you've written a text file named
hello.md with your presentation compile it with
and if everything works,
hello.html should be ready to go! Follow the examples below and dig into tutorial.md for more syntax usage. To continuously rebuild every 3 seconds add the flag
All slides are separated by
----. Hello world in miniprez looks like:
---- Hello world.
Let's add some style to it!
----- @h1 .text-landing Hello world.
The syntax to miniprez is pretty simple simple, each line is mostly independent of the others.
@ symbol creates a new html element and the
. applies a class to that element, thus the first line becomes
<h1 class="text-landing">Hello world.</h1>.
If you want tags to nest into each other, whitespace matters
@h1 This is big text. @strong This is big bold text.
If all you want to do is create a div with a class you don't need to explicitly say
@div, for example:
Inline markdown shortcuts that work too,
This is **bold**, this is _italic_, this is `code`, this is a [link](www.github.com/thoppe).
This is a :smile: and this is ::twitter:: and and equation $(a+b)^2$.
Lists can be made from either a combination of
@li elements or simply
+ list item one + list item two + list item three
Columns can be built up from
.column or use the shorthand for a column
.grid | # Big title | some text
Large code fences made from
``` and will be automatically code highlighted
``` for x in A: print (x**2) ```
Element arguments can be added with like this
With this syntax there are some additional elements miniprez has added
||Horizontal||Shortcut for hr|
- webslides: Custom CSS
- code prettify: Syntax highlighting
- Beautiful Soup
- Custom tags (background, background_video, line, button, figure)
- Code blocks
- Background videos examples!
- Nested divs
- List support
- Support for command line compilation
- Embedding tools (convert project to monolith html)
- Global options (font?)
- Selectively load libraries (e.g. font-awesome & KaTeX) on use
- Slide number URL
First presented at DC: Hack && Tell Round 41: Polka Sprockets.