reveal.js icon indicating copy to clipboard operation
reveal.js copied to clipboard

speakers notes with markdown (rmd)

Open daaronr opened this issue 5 years ago • 7 comments

The speaker notes feature is described in https://github.com/hakimel/reveal.js#speaker-notes

I can get this to work with the suggested

---


<aside class="notes">
		Oh hey, these are some notes. They'll be hidden in your presentation, but you can see them if you open the speaker notes window (hit »S« on your keyboard).
	</aside>

---

but not with the suggested

--- 

<section data-markdown="example.md" data-separator="^\n\n\n" data-separator-vertical="^\n\n" data-separator-notes="^Note:"></section>

hi

Note: 
does this do it?
---

For the latter, the 'Note: does this do it?' part is not hidden.
Can anyone clarify what Hakimel intended by the latter?

daaronr avatar May 07 '19 19:05 daaronr

You're evidently attempting to use external markdown; your content would be parsed from a file nameexample.md. So, to clarify:

In index.html, put:

<section data-markdown="example.md" 
         data-separator="^\n\n\n"
         data-separator-vertical="^\n\n"
         data-separator-notes="^Note:"></section>

In a file named example.md, put:

hi

Note: 
does this do it?

fghaas avatar May 13 '19 15:05 fghaas

Aha, thanks. I should have known something was afoot with that data-markdown="example.md" bit. But I'm a bit confused about how this could work with r-markdown (.Rmd) in the Rstudio environment.

Minimal example saved as example.Rmd

---
title: "Untitled"
output:
  revealjs::revealjs_presentation:
    self_contained: false
    reveal_plugins: ["notes"]
    theme: white
    highlight: pygments
    transition: fade
    css: reveal.css
---

blank 

---

## R Markdown

hi

Note: 
this is supposed to be a note.

---

I then could put an index.html file with your suggested code (replacing "example.md| with "example.Rmd")

  • in the same folder
  • or adding it to the bottom of $HOME/reveal.js/reveal.js/index.html

In fact I've tried both and neither work. ... the 'note' simply comes out on the slides as regular text.

What am I doing wrong/how can I get the compiler to use the commands in this index.html file?

daaronr avatar May 13 '19 17:05 daaronr

Make double sure there are no spaces before "Note:". That's what happened to be.

JC5 avatar May 18 '19 06:05 JC5

Nope, no spaces.

daaronr avatar May 18 '19 15:05 daaronr

The speaker notes feature is described in https://github.com/hakimel/reveal.js#speaker-notes

I can get this to work with the suggested

---


<aside class="notes">
		Oh hey, these are some notes. They'll be hidden in your presentation, but you can see them if you open the speaker notes window (hit »S« on your keyboard).
	</aside>

---

but not with the suggested

--- 

<section data-markdown="example.md" data-separator="^\n\n\n" data-separator-vertical="^\n\n" data-separator-notes="^Note:"></section>

hi

Note: 
does this do it?
---

For the latter, the 'Note: does this do it?' part is not hidden. Can anyone clarify what Hakimel intended by the latter?

Same problem with you.

ding avatar Sep 23 '20 03:09 ding

So, did anyone figure this out?

My expectation would be replacing this:

<section>
  <h1>My slide</h1>
  <aside class="notes">
    My notes to this slide, blah blah
  </aside>
<section>

to (a pseudocode, the real syntax might be different) this:

<section>
  <h1>My slide</h1>
  <aside class="notes">
    <section data-markdown>
      # my notes to this slide
      *  blah
      * blah
    </section>
  </aside>
<section>

tomaszdudek7 avatar Oct 06 '21 06:10 tomaszdudek7

I don't see this documented anywhere still, but you can do this:

        <section>
          <div data-markdown>
          ## The slide title

          * Item 1
          * Item 2
          * Item 3
          * Item 4
          </div>

          <aside class="notes" data-markdown>
            * My speaker notes go here
            * Markdown works as expected
          </aside>
        </section>

cweagans avatar Oct 06 '23 19:10 cweagans