From 12c9977cda3ceed969c3b24a15dfe33eb2a3e7e4 Mon Sep 17 00:00:00 2001 From: Hakim El Hattab Date: Tue, 31 Jul 2012 02:49:02 -0300 Subject: [PATCH] markdown instructions --- README.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/README.md b/README.md index be330433..2d044f38 100644 --- a/README.md +++ b/README.md @@ -24,6 +24,21 @@ Markup heirarchy needs to be ``
``` +### Markdown + +It's possible to write your slides using Markdown. To enable Markdown simply add the ```data-markdown``` attribute to your ```
``` elements and reveal.js will automatically load the JavaScript parser. + +This is based on [data-markdown](https://gist.github.com/1343518) from [Paul Irish](https://github.com/paulirish) which in turn uses [showdown](https://github.com/coreyti/showdown/). Syntax support seems limited judging by my initial tests, this may be due to conflicts with the reveal.js styles. Updates to come. + +```html +
+ ## Page title + + A paragraph with some text and a [link](http://hakim.se). +
+``` + + ### Configuration At the end of your page, after ````, you need to initialize reveal by running the following code. Note that all config values are optional and will default as specified below.