aboutsummaryrefslogtreecommitdiffhomepage
path: root/README.md
diff options
context:
space:
mode:
authorJosh Nichols2012-09-08 22:10:13 -0400
committerJosh Nichols2012-09-08 22:10:13 -0400
commitdf2ebc570ce921b2d83883dd6dca03f6cd81b6af (patch)
tree712ae9229b782aa79c9cbaebaf4c00171ea4aa92 /README.md
parenta8a3765bec9a490b285f3422be2dd06e5acb65d4 (diff)
Add documentation for markdown speaker notes
Diffstat (limited to 'README.md')
-rw-r--r--README.md4
1 files changed, 3 insertions, 1 deletions
diff --git a/README.md b/README.md
index 8fd0418..3f4ac3c 100644
--- 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