Add documentation for markdown speaker notes

This commit is contained in:
Josh Nichols 2012-09-08 22:10:13 -04:00
parent a8a3765bec
commit df2ebc570c

View File

@ -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. 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`. 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: 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 MIT licensed
Copyright (C) 2011-2012 Hakim El Hattab, http://hakim.se Copyright (C) 2011-2012 Hakim El Hattab, http://hakim.se