From ee8aefcda6209d7af502fd3675ea353a98d9a0c5 Mon Sep 17 00:00:00 2001 From: Dennis Ploeger Date: Wed, 11 Dec 2013 09:16:37 +0100 Subject: [PATCH] Added more documentation --- README.md | 42 ++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 42 insertions(+) diff --git a/README.md b/README.md index 000c216..53c3bae 100644 --- a/README.md +++ b/README.md @@ -51,3 +51,45 @@ and so forth. [Reveal.js]: http://lab.hakim.se/reveal-js/#/ [Jekyll]: http://jekyllrb.com/ [install Jekyll]: http://jekyllrb.com/docs/installation/ + +## Markdown extensions + +Jekyll-Revealjs implements the following extensions: + +To use multiple slides in one slide file, use a newline, three dashes and another newline like this: + + # Slide 1 + + This is the content of Slide 1 + + --- + + # Slide 2 + + This is the content of Slide 2 + +To use vertical slides, do the same, but use two dashes: + + # Slide 1 + + This is the content of Slide 1 + + -- + + And this is a vertical slide below Slide 1 + +To use fragments, you can use the features also described in the Reveal.js-documentation: + + # Slide + + * This + * will + * come one by one + +Use the same technique to set slide backgrounds: + + # Slide + + + + This slide has a white background