From a14a298d305c842d14d823eee6c5aef0ad8c0c42 Mon Sep 17 00:00:00 2001 From: Hakim El Hattab <hakim.elhattab@gmail.com> Date: Wed, 9 Sep 2015 14:28:42 +0200 Subject: [PATCH] document showNotes config value #304 --- README.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/README.md b/README.md index 276fd70..8d25fa7 100644 --- a/README.md +++ b/README.md @@ -738,6 +738,8 @@ reveal.js comes with a speaker notes plugin which can be used to present per-sli Notes are defined by appending an ```<aside>``` element to a slide as seen below. You can add the ```data-markdown``` attribute to the aside element if you prefer writing notes using Markdown. +Alternatively you can add your notes in a `data-notes` attribute on the slide. Like `<section data-notes="Something important"></section>`. + When used locally, this feature requires that reveal.js [runs from a local web server](#full-setup). ```html @@ -750,6 +752,8 @@ When used locally, this feature requires that reveal.js [runs from a local web s </section> ``` +Notes are only visible to you in the speaker view. If you wish to share your notes with the audience initialize reveal.js with the `showNotes` config value set to `true`. + If you're using the external Markdown plugin, you can add notes with the help of a special delimiter: ```html -- GitLab