search

fsprojects / FsReveal

FsReveal parses markdown and F# script file and generates reveal.js slides.
http://fsprojects.github.io/FsReveal
258 stars 100 forks source link

Simpler way of defining speaker notes in markdown #32

Closed artur-s closed 9 years ago

artur-s commented 9 years ago

Currently, to add speaker notes using markdown, the <aside> HTML tag decorated with notes class has to be used. For example:

<aside class="notes">Oh hey, these are some notes.</aside>

Defining speaker nodes in a more concise way would be useful.

For example: /// Oh hey, these are some notes. Or markdown-compliant way, where the note is not included in HTML view (based on SO question): [//]: # (Oh hey, these are some notes.)

forki commented 9 years ago

@troykershaw @kimsk what do you think?

forki commented 9 years ago

I think triple slashes will be used for F# XML comments. How about:

' Oh hey, these are some notes.
' And some more
artur-s commented 9 years ago

I like the single quote. It is clear and not common as a first character in a line.

forki commented 9 years ago

please take a look at https://github.com/fsprojects/FsReveal/pull/48

artur-s commented 9 years ago

@forki, Currently only the first speaker note line appears on the slide notes. It looks like only one <aside> element is supported.