Skip to content

Commit 4068c52

Browse files
committed
add instructions to features that require a local web server (closes hakimel#732, hakimel#673, hakimel#559)
1 parent e6069ca commit 4068c52

File tree

1 file changed

+11
-2
lines changed

1 file changed

+11
-2
lines changed

README.md

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -54,8 +54,15 @@ This is based on [data-markdown](https://gist.github.com/1343518) from [Paul Iri
5454

5555
You can write your content as a separate file and have reveal.js load it at runtime. Note the separator arguments which determine how slides are delimited in the external file. The ```data-charset``` attribute is optional and specifies which charset to use when loading the external file.
5656

57+
When used locally, this feature requires that reveal.js [runs from a local web server](#full-setup).
58+
5759
```html
58-
<section data-markdown="example.md" data-separator="^\n\n\n" data-vertical="^\n\n" data-notes="^Note:" data-charset="iso-8859-15"></section>
60+
<section data-markdown="example.md"
61+
data-separator="^\n\n\n"
62+
data-vertical="^\n\n"
63+
data-notes="^Note:"
64+
data-charset="iso-8859-15">
65+
</section>
5966
```
6067

6168
#### Element Attributes
@@ -592,6 +599,8 @@ reveal.js comes with a speaker notes plugin which can be used to present per-sli
592599

593600
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.
594601

602+
When used locally, this feature requires that reveal.js [runs from a local web server](#full-setup).
603+
595604
```html
596605
<section>
597606
<h2>Some Slide</h2>
@@ -862,7 +871,7 @@ The core of reveal.js is very easy to install. You'll simply need to download a
862871
863872
### Full setup
864873
865-
Some reveal.js features, like external markdown, require that presentations run from a local web server. The following instructions will set up such a server as well as all of the development tasks needed to make edits to the reveal.js source code.
874+
Some reveal.js features, like external markdown and speaker notes, require that presentations run from a local web server. The following instructions will set up such a server as well as all of the development tasks needed to make edits to the reveal.js source code.
866875
867876
1. Install [Node.js](http://nodejs.org/)
868877

0 commit comments

Comments
 (0)