vinyll / html5-slides-markdown

Generate a slideshow using the slides that power the html5-slides presentation

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

html5-slides-markdown

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

A sample slideshow is here.

News

06/11/10 - Current slideshows will need to be updated. As of tonight's changes (48024cfe), title slides are rendered like any other. This means that you must render them to an h1 element (# or = below). This is cleaner and more consistent.

Requirements

python and the following modules:

  • jinja2
  • markdown
  • pygments

Markdown Formatting Instructions

  • To create a title slide, render a single h1 element
  • 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}} as the first indented line
  • See the included slides.md for an example

Rendering Instructions

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

Options

Several options are available using the command line:

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

Options:
  -h, --help            show this help message and exit
  -s FILE, --source=FILE
                        The path to the markdown source file
  -d FILE, --destination=FILE
                        The path to the to the destination
  -t FILE, --template=FILE
                        The path to the to the Jinja2 template file
  -e ENCODING, --encoding=ENCODING
                        The encoding of your files (defaults to utf8)

TODO

  • Test CSS for all Markdown features

Thanks

  • Nicolas Perriault (n1k0)
  • Vincent Agnano (Particules)
  • Brad Cupit (bradcupit)

About

Generate a slideshow using the slides that power the html5-slides presentation


Languages

Language:Python 100.0%