Generate a slideshow using the slides that power the html5-slides presentation
Pull request Compare This branch is even with atiw003:master.
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
html5-slides-markdown
samples
.gitignore
README.md

README.md

html5-slides-markdown


Overview

Generates a slideshow using the slides that power the html5-slides presentation.

demo

A sample slideshow is here.


News

06/18/10 - You must now explicitly provide a source file to render.py. slides.md is no longer assumed. See help for more information.

06/19/10 - Project layout is currently being reorganized, to prepare future packaging -- btw we're still looking after a cool name, if you got ideas feel free to suggest on the dedicated issue thread. Also, some tests have been added, more to come though.


Features

  • Write your slide contents easily using the Markdown syntax
  • HTML5, Web based, stand-alone document (embedded local images), fancy transitions
  • PDF export (using PrinceXML if available)

Requirements

python and the following modules:

  • jinja2
  • markdown
  • pygments

Markdown Formatting Instructions

  • To create a title slide, render a single h1 element (eg. # My Title)
  • Separate your slides with a horizontal rule (--- in markdown)
  • Your other slides should have a heading that renders to an h1 element
  • To highlight blocks of code, put !{lang} where {lang} is the pygment supported language identifier as the first indented line
  • See the included slides.md for an example

Rendering Instructions

  • Put your markdown content in a Markdown file, eg slides.md
  • Run python render.py slides.md (or ./render.py slides.md)
  • Enjoy your newly generated presentation.html

As a proof of concept, you can even transform this annoying README into a fancy presentation:

$ ./render.py README.md && open presentation.html

Or get it as a PDF document, at least if PrinceXML is installed and available on your system:

$ ./render.py README.md -d readme.pdf
$ open readme.pdf

Options

Several options are available using the command line:

$ ./render.py --help
Usage: render.py [options] input ...

Generates fancy HTML5 or PDF slideshows from Markdown sources

Options:
  -h, --help            show this help message and exit
  -b, --debug           Will display any exception trace to stdin
  -d FILE, --destination=FILE
                        The path to the to the destination file: .html or .pdf
                        extensions allowed (default: presentation.html)
  -e ENCODING, --encoding=ENCODING
                        The encoding of your files (defaults to utf8)
  -i, --embed           Embed base64-encoded images in presentation
  -t FILE, --template=FILE
                        The path to a Jinja2 compatible template file
  -o, --direct-ouput    Prints the generated HTML code to stdin; won't work
                        with PDF export
  -q, --quiet           Won't write anything to stdin (silent mode)
  -v, --verbose         Write informational messages to stdin (enabled by
                        default)

Note: PDF export requires the `prince` program: http://princexml.com/

Advanced Usage

Setting Custom Destination File

$ ./render.py slides.md -d ~/MyPresentations/KeynoteKiller.html

Working with Directories

$ ./render.py slides/

Working with Direct Output

$ ./render.py slides.md -o |tidy

Using an Alternate Jinja2 Template

$ ./render.py slides.md -t ~/templates/mytemplate.html

Embedding Base-64-Encoded Images

$ ./render.py slides.md -i

Exporting to PDF

$ ./render.py slides.md -d PowerpointIsDead.pdf

TODO

  • Create a pip and setuptools compatible package, and therefore find a cool name for it
  • Manage presentation projects, each one having its own configuration file; the configuration file could configure:
    • theme (template, assets, etc)
    • sources to order and aggregate
    • destination
    • options
  • Make sure images are correctly embedded, both in html and pdf presentations
  • Write tests
  • Handle the case of markdown files aggregation, atm its necessary to write a --- separator at the end of each one but the last

Authors