Add documentation for markdown speaker notes
authorJosh Nichols <josh@technicalpickles.com>
Sun, 9 Sep 2012 02:10:13 +0000 (22:10 -0400)
committerJosh Nichols <josh@technicalpickles.com>
Sun, 9 Sep 2012 02:10:13 +0000 (22:10 -0400)
README.md

index 8fd04183a9b131aa7e55b863e9e7f7e9b598945f..3f4ac3cec096e15a4e3e1d49ad72ba3495d70f98 100644 (file)
--- a/README.md
+++ b/README.md
@@ -199,6 +199,8 @@ If you're interested in using speaker notes, reveal.js comes with a Node server
 
 To include speaker notes in your presentation, simply add an `<aside class="notes">` element to any slide. These notes will be hidden in the main presentation view.
 
+It's also possible to write your notes with Markdown. To enable Markdown, simply add the ```data-markdown``` attribute to your ```<aside>``` elements and reveal.js will automatically load the JavaScript parser.
+
 You'll also need to [install Node.js](http://nodejs.org/); then, install the server dependencies by running `npm install`.
 
 Once Node.js and the dependencies are installed, run the following command from the root directory:
@@ -223,4 +225,4 @@ You can change the appearance of the speaker notes by editing the file at `plugi
 
 MIT licensed
 
-Copyright (C) 2011-2012 Hakim El Hattab, http://hakim.se
\ No newline at end of file
+Copyright (C) 2011-2012 Hakim El Hattab, http://hakim.se