slideit 0.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (115) hide show
  1. checksums.yaml +7 -0
  2. data/.gitignore +9 -0
  3. data/.travis.yml +5 -0
  4. data/CODE_OF_CONDUCT.md +49 -0
  5. data/Gemfile +4 -0
  6. data/README.md +38 -0
  7. data/Rakefile +10 -0
  8. data/bin/slideit +34 -0
  9. data/lib/slideit/version.rb +3 -0
  10. data/lib/slideit.rb +110 -0
  11. data/res/reveal.js-3.3.0/.gitignore +13 -0
  12. data/res/reveal.js-3.3.0/.travis.yml +5 -0
  13. data/res/reveal.js-3.3.0/CONTRIBUTING.md +23 -0
  14. data/res/reveal.js-3.3.0/Gruntfile.js +176 -0
  15. data/res/reveal.js-3.3.0/LICENSE +19 -0
  16. data/res/reveal.js-3.3.0/README.md +1104 -0
  17. data/res/reveal.js-3.3.0/bower.json +27 -0
  18. data/res/reveal.js-3.3.0/css/print/paper.css +202 -0
  19. data/res/reveal.js-3.3.0/css/print/pdf.css +160 -0
  20. data/res/reveal.js-3.3.0/css/reveal.css +1331 -0
  21. data/res/reveal.js-3.3.0/css/reveal.scss +1411 -0
  22. data/res/reveal.js-3.3.0/css/theme/README.md +21 -0
  23. data/res/reveal.js-3.3.0/css/theme/beige.css +291 -0
  24. data/res/reveal.js-3.3.0/css/theme/black.css +287 -0
  25. data/res/reveal.js-3.3.0/css/theme/blood.css +310 -0
  26. data/res/reveal.js-3.3.0/css/theme/league.css +293 -0
  27. data/res/reveal.js-3.3.0/css/theme/moon.css +291 -0
  28. data/res/reveal.js-3.3.0/css/theme/night.css +285 -0
  29. data/res/reveal.js-3.3.0/css/theme/serif.css +287 -0
  30. data/res/reveal.js-3.3.0/css/theme/simple.css +287 -0
  31. data/res/reveal.js-3.3.0/css/theme/sky.css +294 -0
  32. data/res/reveal.js-3.3.0/css/theme/solarized.css +291 -0
  33. data/res/reveal.js-3.3.0/css/theme/source/beige.scss +39 -0
  34. data/res/reveal.js-3.3.0/css/theme/source/black.scss +49 -0
  35. data/res/reveal.js-3.3.0/css/theme/source/blood.scss +79 -0
  36. data/res/reveal.js-3.3.0/css/theme/source/league.scss +34 -0
  37. data/res/reveal.js-3.3.0/css/theme/source/moon.scss +57 -0
  38. data/res/reveal.js-3.3.0/css/theme/source/night.scss +35 -0
  39. data/res/reveal.js-3.3.0/css/theme/source/serif.scss +35 -0
  40. data/res/reveal.js-3.3.0/css/theme/source/simple.scss +38 -0
  41. data/res/reveal.js-3.3.0/css/theme/source/sky.scss +46 -0
  42. data/res/reveal.js-3.3.0/css/theme/source/solarized.scss +63 -0
  43. data/res/reveal.js-3.3.0/css/theme/source/white.scss +49 -0
  44. data/res/reveal.js-3.3.0/css/theme/template/mixins.scss +29 -0
  45. data/res/reveal.js-3.3.0/css/theme/template/settings.scss +43 -0
  46. data/res/reveal.js-3.3.0/css/theme/template/theme.scss +346 -0
  47. data/res/reveal.js-3.3.0/css/theme/white.css +287 -0
  48. data/res/reveal.js-3.3.0/demo.html +410 -0
  49. data/res/reveal.js-3.3.0/index.html +52 -0
  50. data/res/reveal.js-3.3.0/js/reveal.js +4744 -0
  51. data/res/reveal.js-3.3.0/lib/css/zenburn.css +80 -0
  52. data/res/reveal.js-3.3.0/lib/font/league-gothic/LICENSE +2 -0
  53. data/res/reveal.js-3.3.0/lib/font/league-gothic/league-gothic.css +10 -0
  54. data/res/reveal.js-3.3.0/lib/font/league-gothic/league-gothic.eot +0 -0
  55. data/res/reveal.js-3.3.0/lib/font/league-gothic/league-gothic.ttf +0 -0
  56. data/res/reveal.js-3.3.0/lib/font/league-gothic/league-gothic.woff +0 -0
  57. data/res/reveal.js-3.3.0/lib/font/source-sans-pro/LICENSE +45 -0
  58. data/res/reveal.js-3.3.0/lib/font/source-sans-pro/source-sans-pro-italic.eot +0 -0
  59. data/res/reveal.js-3.3.0/lib/font/source-sans-pro/source-sans-pro-italic.ttf +0 -0
  60. data/res/reveal.js-3.3.0/lib/font/source-sans-pro/source-sans-pro-italic.woff +0 -0
  61. data/res/reveal.js-3.3.0/lib/font/source-sans-pro/source-sans-pro-regular.eot +0 -0
  62. data/res/reveal.js-3.3.0/lib/font/source-sans-pro/source-sans-pro-regular.ttf +0 -0
  63. data/res/reveal.js-3.3.0/lib/font/source-sans-pro/source-sans-pro-regular.woff +0 -0
  64. data/res/reveal.js-3.3.0/lib/font/source-sans-pro/source-sans-pro-semibold.eot +0 -0
  65. data/res/reveal.js-3.3.0/lib/font/source-sans-pro/source-sans-pro-semibold.ttf +0 -0
  66. data/res/reveal.js-3.3.0/lib/font/source-sans-pro/source-sans-pro-semibold.woff +0 -0
  67. data/res/reveal.js-3.3.0/lib/font/source-sans-pro/source-sans-pro-semibolditalic.eot +0 -0
  68. data/res/reveal.js-3.3.0/lib/font/source-sans-pro/source-sans-pro-semibolditalic.ttf +0 -0
  69. data/res/reveal.js-3.3.0/lib/font/source-sans-pro/source-sans-pro-semibolditalic.woff +0 -0
  70. data/res/reveal.js-3.3.0/lib/font/source-sans-pro/source-sans-pro.css +39 -0
  71. data/res/reveal.js-3.3.0/lib/js/classList.js +2 -0
  72. data/res/reveal.js-3.3.0/lib/js/head.min.js +9 -0
  73. data/res/reveal.js-3.3.0/lib/js/html5shiv.js +7 -0
  74. data/res/reveal.js-3.3.0/package.json +44 -0
  75. data/res/reveal.js-3.3.0/plugin/highlight/highlight.js +31 -0
  76. data/res/reveal.js-3.3.0/plugin/markdown/example.html +129 -0
  77. data/res/reveal.js-3.3.0/plugin/markdown/example.md +31 -0
  78. data/res/reveal.js-3.3.0/plugin/markdown/markdown.js +405 -0
  79. data/res/reveal.js-3.3.0/plugin/markdown/marked.js +6 -0
  80. data/res/reveal.js-3.3.0/plugin/math/math.js +67 -0
  81. data/res/reveal.js-3.3.0/plugin/multiplex/client.js +13 -0
  82. data/res/reveal.js-3.3.0/plugin/multiplex/index.js +64 -0
  83. data/res/reveal.js-3.3.0/plugin/multiplex/master.js +31 -0
  84. data/res/reveal.js-3.3.0/plugin/multiplex/package.json +19 -0
  85. data/res/reveal.js-3.3.0/plugin/notes/notes.html +414 -0
  86. data/res/reveal.js-3.3.0/plugin/notes/notes.js +136 -0
  87. data/res/reveal.js-3.3.0/plugin/notes-server/client.js +65 -0
  88. data/res/reveal.js-3.3.0/plugin/notes-server/index.js +69 -0
  89. data/res/reveal.js-3.3.0/plugin/notes-server/notes.html +407 -0
  90. data/res/reveal.js-3.3.0/plugin/print-pdf/print-pdf.js +48 -0
  91. data/res/reveal.js-3.3.0/plugin/search/search.js +196 -0
  92. data/res/reveal.js-3.3.0/plugin/zoom-js/zoom.js +278 -0
  93. data/res/reveal.js-3.3.0/simple.html +90 -0
  94. data/res/reveal.js-3.3.0/test/examples/assets/image1.png +0 -0
  95. data/res/reveal.js-3.3.0/test/examples/assets/image2.png +0 -0
  96. data/res/reveal.js-3.3.0/test/examples/barebones.html +41 -0
  97. data/res/reveal.js-3.3.0/test/examples/embedded-media.html +49 -0
  98. data/res/reveal.js-3.3.0/test/examples/math.html +185 -0
  99. data/res/reveal.js-3.3.0/test/examples/slide-backgrounds.html +144 -0
  100. data/res/reveal.js-3.3.0/test/examples/slide-transitions.html +101 -0
  101. data/res/reveal.js-3.3.0/test/qunit-1.12.0.css +244 -0
  102. data/res/reveal.js-3.3.0/test/qunit-1.12.0.js +2212 -0
  103. data/res/reveal.js-3.3.0/test/test-markdown-element-attributes.html +134 -0
  104. data/res/reveal.js-3.3.0/test/test-markdown-element-attributes.js +46 -0
  105. data/res/reveal.js-3.3.0/test/test-markdown-slide-attributes.html +128 -0
  106. data/res/reveal.js-3.3.0/test/test-markdown-slide-attributes.js +47 -0
  107. data/res/reveal.js-3.3.0/test/test-markdown.html +52 -0
  108. data/res/reveal.js-3.3.0/test/test-markdown.js +15 -0
  109. data/res/reveal.js-3.3.0/test/test-pdf.html +83 -0
  110. data/res/reveal.js-3.3.0/test/test-pdf.js +15 -0
  111. data/res/reveal.js-3.3.0/test/test.html +86 -0
  112. data/res/reveal.js-3.3.0/test/test.js +597 -0
  113. data/res/reveal.js-3.3.0/test.md +31 -0
  114. data/slideit.gemspec +25 -0
  115. metadata +199 -0
data/res/reveal.js-3.3.0/README.md ADDED
@@ -0,0 +1,1104 @@
1
+ # reveal.js [![Build Status](https://travis-ci.org/hakimel/reveal.js.svg?branch=master)](https://travis-ci.org/hakimel/reveal.js)
2
+
3
+ A framework for easily creating beautiful presentations using HTML. [Check out the live demo](http://lab.hakim.se/reveal-js/).
4
+
5
+ reveal.js comes with a broad range of features including [nested slides](https://github.com/hakimel/reveal.js#markup), [Markdown contents](https://github.com/hakimel/reveal.js#markdown), [PDF export](https://github.com/hakimel/reveal.js#pdf-export), [speaker notes](https://github.com/hakimel/reveal.js#speaker-notes) and a [JavaScript API](https://github.com/hakimel/reveal.js#api). There's also a fully featured visual editor and platform for sharing reveal.js presentations at [slides.com](https://slides.com).
6
+
7
+ ## Table of contents
8
+ - [Online Editor](#online-editor)
9
+ - [Instructions](#instructions)
10
+ - [Markup](#markup)
11
+ - [Markdown](#markdown)
12
+ - [Element Attributes](#element-attributes)
13
+ - [Slide Attributes](#slide-attributes)
14
+ - [Configuration](#configuration)
15
+ - [Presentation Size](#presentation-size)
16
+ - [Dependencies](#dependencies)
17
+ - [Ready Event](#ready-event)
18
+ - [Auto-sliding](#auto-sliding)
19
+ - [Keyboard Bindings](#keyboard-bindings)
20
+ - [Touch Navigation](#touch-navigation)
21
+ - [Lazy Loading](#lazy-loading)
22
+ - [API](#api)
23
+ - [Slide Changed Event](#slide-changed-event)
24
+ - [Presentation State](#presentation-state)
25
+ - [Slide States](#slide-states)
26
+ - [Slide Backgrounds](#slide-backgrounds)
27
+ - [Parallax Background](#parallax-background)
28
+ - [Slide Transitions](#slide-transitions)
29
+ - [Internal links](#internal-links)
30
+ - [Fragments](#fragments)
31
+ - [Fragment events](#fragment-events)
32
+ - [Code syntax highlighting](#code-syntax-highlighting)
33
+ - [Slide number](#slide-number)
34
+ - [Overview mode](#overview-mode)
35
+ - [Fullscreen mode](#fullscreen-mode)
36
+ - [Embedded media](#embedded-media)
37
+ - [Stretching elements](#stretching-elements)
38
+ - [postMessage API](#postmessage-api)
39
+ - [PDF Export](#pdf-export)
40
+ - [Theming](#theming)
41
+ - [Speaker Notes](#speaker-notes)
42
+ - [Share and Print Speaker Notes](#share-and-print-speaker-notes)
43
+ - [Server Side Speaker Notes](#server-side-speaker-notes)
44
+ - [Multiplexing](#multiplexing)
45
+ - [Master presentation](#master-presentation)
46
+ - [Client presentation](#client-presentation)
47
+ - [Socket.io server](#socketio-server)
48
+ - [MathJax](#mathjax)
49
+ - [Installation](#installation)
50
+ - [Basic setup](#basic-setup)
51
+ - [Full setup](#full-setup)
52
+ - [Folder Structure](#folder-structure)
53
+ - [License](#license)
54
+
55
+ #### More reading
56
+ - [Changelog](https://github.com/hakimel/reveal.js/releases): Up-to-date version history.
57
+ - [Examples](https://github.com/hakimel/reveal.js/wiki/Example-Presentations): Presentations created with reveal.js, add your own!
58
+ - [Browser Support](https://github.com/hakimel/reveal.js/wiki/Browser-Support): Explanation of browser support and fallbacks.
59
+ - [Plugins](https://github.com/hakimel/reveal.js/wiki/Plugins,-Tools-and-Hardware): A list of plugins that can be used to extend reveal.js.
60
+
61
+ ## Online Editor
62
+
63
+ Presentations are written using HTML or Markdown but there's also an online editor for those of you who prefer a graphical interface. Give it a try at [http://slides.com](http://slides.com?ref=github).
64
+
65
+
66
+ ## Instructions
67
+
68
+ ### Markup
69
+
70
+ Here's a barebones example of a fully working reveal.js presentation:
71
+ ```html
72
+ <html>
73
+ <head>
74
+ <link rel="stylesheet" href="css/reveal.css">
75
+ <link rel="stylesheet" href="css/theme/white.css">
76
+ </head>
77
+ <body>
78
+ <div class="reveal">
79
+ <div class="slides">
80
+ <section>Slide 1</section>
81
+ <section>Slide 2</section>
82
+ </div>
83
+ </div>
84
+ <script src="js/reveal.js"></script>
85
+ <script>
86
+ Reveal.initialize();
87
+ </script>
88
+ </body>
89
+ </html>
90
+ ```
91
+
92
+ The presentation markup hierarchy needs to be `.reveal > .slides > section` where the `section` represents one slide and can be repeated indefinitely. If you place multiple `section` elements inside of another `section` they will be shown as vertical slides. The first of the vertical slides is the "root" of the others (at the top), and will be included in the horizontal sequence. For example:
93
+
94
+ ```html
95
+ <div class="reveal">
96
+ <div class="slides">
97
+ <section>Single Horizontal Slide</section>
98
+ <section>
99
+ <section>Vertical Slide 1</section>
100
+ <section>Vertical Slide 2</section>
101
+ </section>
102
+ </div>
103
+ </div>
104
+ ```
105
+
106
+ ### Markdown
107
+
108
+ It's possible to write your slides using Markdown. To enable Markdown, add the ```data-markdown``` attribute to your ```<section>``` elements and wrap the contents in a ```<script type="text/template">``` like the example below.
109
+
110
+ This is based on [data-markdown](https://gist.github.com/1343518) from [Paul Irish](https://github.com/paulirish) modified to use [marked](https://github.com/chjj/marked) to support [GitHub Flavored Markdown](https://help.github.com/articles/github-flavored-markdown). Sensitive to indentation (avoid mixing tabs and spaces) and line breaks (avoid consecutive breaks).
111
+
112
+ ```html
113
+ <section data-markdown>
114
+ <script type="text/template">
115
+ ## Page title
116
+
117
+ A paragraph with some text and a [link](http://hakim.se).
118
+ </script>
119
+ </section>
120
+ ```
121
+
122
+ #### External Markdown
123
+
124
+ 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.
125
+
126
+ When used locally, this feature requires that reveal.js [runs from a local web server](#full-setup).
127
+
128
+ ```html
129
+ <section data-markdown="example.md"
130
+ data-separator="^\n\n\n"
131
+ data-separator-vertical="^\n\n"
132
+ data-separator-notes="^Note:"
133
+ data-charset="iso-8859-15">
134
+ </section>
135
+ ```
136
+
137
+ #### Element Attributes
138
+
139
+ Special syntax (in html comment) is available for adding attributes to Markdown elements. This is useful for fragments, amongst other things.
140
+
141
+ ```html
142
+ <section data-markdown>
143
+ <script type="text/template">
144
+ - Item 1 <!-- .element: class="fragment" data-fragment-index="2" -->
145
+ - Item 2 <!-- .element: class="fragment" data-fragment-index="1" -->
146
+ </script>
147
+ </section>
148
+ ```
149
+
150
+ #### Slide Attributes
151
+
152
+ Special syntax (in html comment) is available for adding attributes to the slide `<section>` elements generated by your Markdown.
153
+
154
+ ```html
155
+ <section data-markdown>
156
+ <script type="text/template">
157
+ <!-- .slide: data-background="#ff0000" -->
158
+ Markdown content
159
+ </script>
160
+ </section>
161
+ ```
162
+
163
+
164
+ ### Configuration
165
+
166
+ At the end of your page you need to initialize reveal by running the following code. Note that all config values are optional and will default as specified below.
167
+
168
+ ```javascript
169
+ Reveal.initialize({
170
+
171
+ // Display controls in the bottom right corner
172
+ controls: true,
173
+
174
+ // Display a presentation progress bar
175
+ progress: true,
176
+
177
+ // Display the page number of the current slide
178
+ slideNumber: false,
179
+
180
+ // Push each slide change to the browser history
181
+ history: false,
182
+
183
+ // Enable keyboard shortcuts for navigation
184
+ keyboard: true,
185
+
186
+ // Enable the slide overview mode
187
+ overview: true,
188
+
189
+ // Vertical centering of slides
190
+ center: true,
191
+
192
+ // Enables touch navigation on devices with touch input
193
+ touch: true,
194
+
195
+ // Loop the presentation
196
+ loop: false,
197
+
198
+ // Change the presentation direction to be RTL
199
+ rtl: false,
200
+
201
+ // Randomizes the order of slides each time the presentation loads
202
+ shuffle: false,
203
+
204
+ // Turns fragments on and off globally
205
+ fragments: true,
206
+
207
+ // Flags if the presentation is running in an embedded mode,
208
+ // i.e. contained within a limited portion of the screen
209
+ embedded: false,
210
+
211
+ // Flags if we should show a help overlay when the questionmark
212
+ // key is pressed
213
+ help: true,
214
+
215
+ // Flags if speaker notes should be visible to all viewers
216
+ showNotes: false,
217
+
218
+ // Number of milliseconds between automatically proceeding to the
219
+ // next slide, disabled when set to 0, this value can be overwritten
220
+ // by using a data-autoslide attribute on your slides
221
+ autoSlide: 0,
222
+
223
+ // Stop auto-sliding after user input
224
+ autoSlideStoppable: true,
225
+
226
+ // Use this method for navigation when auto-sliding
227
+ autoSlideMethod: Reveal.navigateNext,
228
+
229
+ // Enable slide navigation via mouse wheel
230
+ mouseWheel: false,
231
+
232
+ // Hides the address bar on mobile devices
233
+ hideAddressBar: true,
234
+
235
+ // Opens links in an iframe preview overlay
236
+ previewLinks: false,
237
+
238
+ // Transition style
239
+ transition: 'default', // none/fade/slide/convex/concave/zoom
240
+
241
+ // Transition speed
242
+ transitionSpeed: 'default', // default/fast/slow
243
+
244
+ // Transition style for full page slide backgrounds
245
+ backgroundTransition: 'default', // none/fade/slide/convex/concave/zoom
246
+
247
+ // Number of slides away from the current that are visible
248
+ viewDistance: 3,
249
+
250
+ // Parallax background image
251
+ parallaxBackgroundImage: '', // e.g. "'https://s3.amazonaws.com/hakim-static/reveal-js/reveal-parallax-1.jpg'"
252
+
253
+ // Parallax background size
254
+ parallaxBackgroundSize: '', // CSS syntax, e.g. "2100px 900px"
255
+
256
+ // Number of pixels to move the parallax background per slide
257
+ // - Calculated automatically unless specified
258
+ // - Set to 0 to disable movement along an axis
259
+ parallaxBackgroundHorizontal: null,
260
+ parallaxBackgroundVertical: null
261
+
262
+ });
263
+ ```
264
+
265
+
266
+ The configuration can be updated after initialization using the ```configure``` method:
267
+
268
+ ```javascript
269
+ // Turn autoSlide off
270
+ Reveal.configure({ autoSlide: 0 });
271
+
272
+ // Start auto-sliding every 5s
273
+ Reveal.configure({ autoSlide: 5000 });
274
+ ```
275
+
276
+
277
+ ### Presentation Size
278
+
279
+ All presentations have a normal size, that is the resolution at which they are authored. The framework will automatically scale presentations uniformly based on this size to ensure that everything fits on any given display or viewport.
280
+
281
+ See below for a list of configuration options related to sizing, including default values:
282
+
283
+ ```javascript
284
+ Reveal.initialize({
285
+
286
+ ...
287
+
288
+ // The "normal" size of the presentation, aspect ratio will be preserved
289
+ // when the presentation is scaled to fit different resolutions. Can be
290
+ // specified using percentage units.
291
+ width: 960,
292
+ height: 700,
293
+
294
+ // Factor of the display size that should remain empty around the content
295
+ margin: 0.1,
296
+
297
+ // Bounds for smallest/largest possible scale to apply to content
298
+ minScale: 0.2,
299
+ maxScale: 1.5
300
+
301
+ });
302
+ ```
303
+
304
+
305
+ ### Dependencies
306
+
307
+ Reveal.js doesn't _rely_ on any third party scripts to work but a few optional libraries are included by default. These libraries are loaded as dependencies in the order they appear, for example:
308
+
309
+ ```javascript
310
+ Reveal.initialize({
311
+ dependencies: [
312
+ // Cross-browser shim that fully implements classList - https://github.com/eligrey/classList.js/
313
+ { src: 'lib/js/classList.js', condition: function() { return !document.body.classList; } },
314
+
315
+ // Interpret Markdown in <section> elements
316
+ { src: 'plugin/markdown/marked.js', condition: function() { return !!document.querySelector( '[data-markdown]' ); } },
317
+ { src: 'plugin/markdown/markdown.js', condition: function() { return !!document.querySelector( '[data-markdown]' ); } },
318
+
319
+ // Syntax highlight for <code> elements
320
+ { src: 'plugin/highlight/highlight.js', async: true, callback: function() { hljs.initHighlightingOnLoad(); } },
321
+
322
+ // Zoom in and out with Alt+click
323
+ { src: 'plugin/zoom-js/zoom.js', async: true },
324
+
325
+ // Speaker notes
326
+ { src: 'plugin/notes/notes.js', async: true },
327
+
328
+ // MathJax
329
+ { src: 'plugin/math/math.js', async: true }
330
+ ]
331
+ });
332
+ ```
333
+
334
+ You can add your own extensions using the same syntax. The following properties are available for each dependency object:
335
+ - **src**: Path to the script to load
336
+ - **async**: [optional] Flags if the script should load after reveal.js has started, defaults to false
337
+ - **callback**: [optional] Function to execute when the script has loaded
338
+ - **condition**: [optional] Function which must return true for the script to be loaded
339
+
340
+
341
+ ### Ready Event
342
+
343
+ A 'ready' event is fired when reveal.js has loaded all non-async dependencies and is ready to start navigating. To check if reveal.js is already 'ready' you can call `Reveal.isReady()`.
344
+
345
+ ```javascript
346
+ Reveal.addEventListener( 'ready', function( event ) {
347
+ // event.currentSlide, event.indexh, event.indexv
348
+ } );
349
+ ```
350
+
351
+
352
+ ### Auto-sliding
353
+
354
+ Presentations can be configured to progress through slides automatically, without any user input. To enable this you will need to tell the framework how many milliseconds it should wait between slides:
355
+
356
+ ```javascript
357
+ // Slide every five seconds
358
+ Reveal.configure({
359
+ autoSlide: 5000
360
+ });
361
+ ```
362
+ When this is turned on a control element will appear that enables users to pause and resume auto-sliding. Alternatively, sliding can be paused or resumed by pressing »a« on the keyboard. Sliding is paused automatically as soon as the user starts navigating. You can disable these controls by specifying ```autoSlideStoppable: false``` in your reveal.js config.
363
+
364
+ You can also override the slide duration for individual slides and fragments by using the ```data-autoslide``` attribute:
365
+
366
+ ```html
367
+ <section data-autoslide="2000">
368
+ <p>After 2 seconds the first fragment will be shown.</p>
369
+ <p class="fragment" data-autoslide="10000">After 10 seconds the next fragment will be shown.</p>
370
+ <p class="fragment">Now, the fragment is displayed for 2 seconds before the next slide is shown.</p>
371
+ </section>
372
+ ```
373
+
374
+ To override the method used for navigation when auto-sliding, you can specify the ```autoSlideMethod``` setting. To only navigate along the top layer and ignore vertical slides, set this to ```Reveal.navigateRight```.
375
+
376
+ Whenever the auto-slide mode is resumed or paused the ```autoslideresumed``` and ```autoslidepaused``` events are fired.
377
+
378
+
379
+ ### Keyboard Bindings
380
+
381
+ If you're unhappy with any of the default keyboard bindings you can override them using the ```keyboard``` config option:
382
+
383
+ ```javascript
384
+ Reveal.configure({
385
+ keyboard: {
386
+ 13: 'next', // go to the next slide when the ENTER key is pressed
387
+ 27: function() {}, // do something custom when ESC is pressed
388
+ 32: null // don't do anything when SPACE is pressed (i.e. disable a reveal.js default binding)
389
+ }
390
+ });
391
+ ```
392
+
393
+ ### Touch Navigation
394
+
395
+ You can swipe to navigate through a presentation on any touch-enabled device. Horizontal swipes change between horizontal slides, vertical swipes change between vertical slides. If you wish to disable this you can set the `touch` config option to false when initializing reveal.js.
396
+
397
+ If there's some part of your content that needs to remain accessible to touch events you'll need to highlight this by adding a `data-prevent-swipe` attribute to the element. One common example where this is useful is elements that need to be scrolled.
398
+
399
+
400
+ ### Lazy Loading
401
+
402
+ When working on presentation with a lot of media or iframe content it's important to load lazily. Lazy loading means that reveal.js will only load content for the few slides nearest to the current slide. The number of slides that are preloaded is determined by the `viewDistance` configuration option.
403
+
404
+ To enable lazy loading all you need to do is change your "src" attributes to "data-src" as shown below. This is supported for image, video, audio and iframe elements. Lazy loaded iframes will also unload when the containing slide is no longer visible.
405
+
406
+ ```html
407
+ <section>
408
+ <img data-src="image.png">
409
+ <iframe data-src="http://hakim.se"></iframe>
410
+ <video>
411
+ <source data-src="video.webm" type="video/webm" />
412
+ <source data-src="video.mp4" type="video/mp4" />
413
+ </video>
414
+ </section>
415
+ ```
416
+
417
+
418
+ ### API
419
+
420
+ The ``Reveal`` object exposes a JavaScript API for controlling navigation and reading state:
421
+
422
+ ```javascript
423
+ // Navigation
424
+ Reveal.slide( indexh, indexv, indexf );
425
+ Reveal.left();
426
+ Reveal.right();
427
+ Reveal.up();
428
+ Reveal.down();
429
+ Reveal.prev();
430
+ Reveal.next();
431
+ Reveal.prevFragment();
432
+ Reveal.nextFragment();
433
+
434
+ // Randomize the order of slides
435
+ Reveal.shuffle();
436
+
437
+ // Toggle presentation states, optionally pass true/false to force on/off
438
+ Reveal.toggleOverview();
439
+ Reveal.togglePause();
440
+ Reveal.toggleAutoSlide();
441
+
442
+ // Change a config value at runtime
443
+ Reveal.configure({ controls: true });
444
+
445
+ // Returns the present configuration options
446
+ Reveal.getConfig();
447
+
448
+ // Fetch the current scale of the presentation
449
+ Reveal.getScale();
450
+
451
+ // Retrieves the previous and current slide elements
452
+ Reveal.getPreviousSlide();
453
+ Reveal.getCurrentSlide();
454
+
455
+ Reveal.getIndices(); // { h: 0, v: 0 } }
456
+ Reveal.getProgress(); // 0-1
457
+ Reveal.getTotalSlides();
458
+
459
+ // Returns the speaker notes for the current slide
460
+ Reveal.getSlideNotes();
461
+
462
+ // State checks
463
+ Reveal.isFirstSlide();
464
+ Reveal.isLastSlide();
465
+ Reveal.isOverview();
466
+ Reveal.isPaused();
467
+ Reveal.isAutoSliding();
468
+ ```
469
+
470
+ ### Slide Changed Event
471
+
472
+ A 'slidechanged' event is fired each time the slide is changed (regardless of state). The event object holds the index values of the current slide as well as a reference to the previous and current slide HTML nodes.
473
+
474
+ Some libraries, like MathJax (see [#226](https://github.com/hakimel/reveal.js/issues/226#issuecomment-10261609)), get confused by the transforms and display states of slides. Often times, this can be fixed by calling their update or render function from this callback.
475
+
476
+ ```javascript
477
+ Reveal.addEventListener( 'slidechanged', function( event ) {
478
+ // event.previousSlide, event.currentSlide, event.indexh, event.indexv
479
+ } );
480
+ ```
481
+
482
+ ### Presentation State
483
+
484
+ The presentation's current state can be fetched by using the `getState` method. A state object contains all of the information required to put the presentation back as it was when `getState` was first called. Sort of like a snapshot. It's a simple object that can easily be stringified and persisted or sent over the wire.
485
+
486
+ ```javascript
487
+ Reveal.slide( 1 );
488
+ // we're on slide 1
489
+
490
+ var state = Reveal.getState();
491
+
492
+ Reveal.slide( 3 );
493
+ // we're on slide 3
494
+
495
+ Reveal.setState( state );
496
+ // we're back on slide 1
497
+ ```
498
+
499
+ ### Slide States
500
+
501
+ If you set ``data-state="somestate"`` on a slide ``<section>``, "somestate" will be applied as a class on the document element when that slide is opened. This allows you to apply broad style changes to the page based on the active slide.
502
+
503
+ Furthermore you can also listen to these changes in state via JavaScript:
504
+
505
+ ```javascript
506
+ Reveal.addEventListener( 'somestate', function() {
507
+ // TODO: Sprinkle magic
508
+ }, false );
509
+ ```
510
+
511
+ ### Slide Backgrounds
512
+
513
+ Slides are contained within a limited portion of the screen by default to allow them to fit any display and scale uniformly. You can apply full page backgrounds outside of the slide area by adding a ```data-background``` attribute to your ```<section>``` elements. Four different types of backgrounds are supported: color, image, video and iframe. Below are a few examples.
514
+
515
+ ```html
516
+ <section data-background="#ff0000">
517
+ <h2>All CSS color formats are supported, like rgba() or hsl().</h2>
518
+ </section>
519
+ <section data-background="http://example.com/image.png">
520
+ <h2>This slide will have a full-size background image.</h2>
521
+ </section>
522
+ <section data-background="http://example.com/image.png" data-background-size="100px" data-background-repeat="repeat">
523
+ <h2>This background image will be sized to 100px and repeated.</h2>
524
+ </section>
525
+ <section data-background-video="https://s3.amazonaws.com/static.slid.es/site/homepage/v1/homepage-video-editor.mp4,https://s3.amazonaws.com/static.slid.es/site/homepage/v1/homepage-video-editor.webm" data-background-video-loop data-background-video-muted>
526
+ <h2>Video. Multiple sources can be defined using a comma separated list. Video will loop when the data-background-video-loop attribute is provided and can be muted with the data-background-video-muted attribute.</h2>
527
+ </section>
528
+ <section data-background-iframe="https://slides.com">
529
+ <h2>Embeds a web page as a background. Note that the page won't be interactive.</h2>
530
+ </section>
531
+ ```
532
+
533
+ Backgrounds transition using a fade animation by default. This can be changed to a linear sliding transition by passing ```backgroundTransition: 'slide'``` to the ```Reveal.initialize()``` call. Alternatively you can set ```data-background-transition``` on any section with a background to override that specific transition.
534
+
535
+
536
+ ### Parallax Background
537
+
538
+ If you want to use a parallax scrolling background, set the first two config properties below when initializing reveal.js (the other two are optional).
539
+
540
+ ```javascript
541
+ Reveal.initialize({
542
+
543
+ // Parallax background image
544
+ parallaxBackgroundImage: '', // e.g. "https://s3.amazonaws.com/hakim-static/reveal-js/reveal-parallax-1.jpg"
545
+
546
+ // Parallax background size
547
+ parallaxBackgroundSize: '', // CSS syntax, e.g. "2100px 900px" - currently only pixels are supported (don't use % or auto)
548
+
549
+ // Number of pixels to move the parallax background per slide
550
+ // - Calculated automatically unless specified
551
+ // - Set to 0 to disable movement along an axis
552
+ parallaxBackgroundHorizontal: 200,
553
+ parallaxBackgroundVertical: 50
554
+
555
+ });
556
+ ```
557
+
558
+ Make sure that the background size is much bigger than screen size to allow for some scrolling. [View example](http://lab.hakim.se/reveal-js/?parallaxBackgroundImage=https%3A%2F%2Fs3.amazonaws.com%2Fhakim-static%2Freveal-js%2Freveal-parallax-1.jpg&parallaxBackgroundSize=2100px%20900px).
559
+
560
+
561
+
562
+ ### Slide Transitions
563
+ The global presentation transition is set using the ```transition``` config value. You can override the global transition for a specific slide by using the ```data-transition``` attribute:
564
+
565
+ ```html
566
+ <section data-transition="zoom">
567
+ <h2>This slide will override the presentation transition and zoom!</h2>
568
+ </section>
569
+
570
+ <section data-transition-speed="fast">
571
+ <h2>Choose from three transition speeds: default, fast or slow!</h2>
572
+ </section>
573
+ ```
574
+
575
+ You can also use different in and out transitions for the same slide:
576
+
577
+ ```html
578
+ <section data-transition="slide">
579
+ The train goes on …
580
+ </section>
581
+ <section data-transition="slide">
582
+ and on …
583
+ </section>
584
+ <section data-transition="slide-in fade-out">
585
+ and stops.
586
+ </section>
587
+ <section data-transition="fade-in slide-out">
588
+ (Passengers entering and leaving)
589
+ </section>
590
+ <section data-transition="slide">
591
+ And it starts again.
592
+ </section>
593
+ ```
594
+
595
+
596
+ ### Internal links
597
+
598
+ It's easy to link between slides. The first example below targets the index of another slide whereas the second targets a slide with an ID attribute (```<section id="some-slide">```):
599
+
600
+ ```html
601
+ <a href="#/2/2">Link</a>
602
+ <a href="#/some-slide">Link</a>
603
+ ```
604
+
605
+ You can also add relative navigation links, similar to the built in reveal.js controls, by appending one of the following classes on any element. Note that each element is automatically given an ```enabled``` class when it's a valid navigation route based on the current slide.
606
+
607
+ ```html
608
+ <a href="#" class="navigate-left">
609
+ <a href="#" class="navigate-right">
610
+ <a href="#" class="navigate-up">
611
+ <a href="#" class="navigate-down">
612
+ <a href="#" class="navigate-prev"> <!-- Previous vertical or horizontal slide -->
613
+ <a href="#" class="navigate-next"> <!-- Next vertical or horizontal slide -->
614
+ ```
615
+
616
+
617
+ ### Fragments
618
+ Fragments are used to highlight individual elements on a slide. Every element with the class ```fragment``` will be stepped through before moving on to the next slide. Here's an example: http://lab.hakim.se/reveal-js/#/fragments
619
+
620
+ The default fragment style is to start out invisible and fade in. This style can be changed by appending a different class to the fragment:
621
+
622
+ ```html
623
+ <section>
624
+ <p class="fragment grow">grow</p>
625
+ <p class="fragment shrink">shrink</p>
626
+ <p class="fragment fade-out">fade-out</p>
627
+ <p class="fragment fade-up">fade-up (also down, left and right!)</p>
628
+ <p class="fragment current-visible">visible only once</p>
629
+ <p class="fragment highlight-current-blue">blue only once</p>
630
+ <p class="fragment highlight-red">highlight-red</p>
631
+ <p class="fragment highlight-green">highlight-green</p>
632
+ <p class="fragment highlight-blue">highlight-blue</p>
633
+ </section>
634
+ ```
635
+
636
+ Multiple fragments can be applied to the same element sequentially by wrapping it, this will fade in the text on the first step and fade it back out on the second.
637
+
638
+ ```html
639
+ <section>
640
+ <span class="fragment fade-in">
641
+ <span class="fragment fade-out">I'll fade in, then out</span>
642
+ </span>
643
+ </section>
644
+ ```
645
+
646
+ The display order of fragments can be controlled using the ```data-fragment-index``` attribute.
647
+
648
+ ```html
649
+ <section>
650
+ <p class="fragment" data-fragment-index="3">Appears last</p>
651
+ <p class="fragment" data-fragment-index="1">Appears first</p>
652
+ <p class="fragment" data-fragment-index="2">Appears second</p>
653
+ </section>
654
+ ```
655
+
656
+ ### Fragment events
657
+
658
+ When a slide fragment is either shown or hidden reveal.js will dispatch an event.
659
+
660
+ Some libraries, like MathJax (see #505), get confused by the initially hidden fragment elements. Often times this can be fixed by calling their update or render function from this callback.
661
+
662
+ ```javascript
663
+ Reveal.addEventListener( 'fragmentshown', function( event ) {
664
+ // event.fragment = the fragment DOM element
665
+ } );
666
+ Reveal.addEventListener( 'fragmenthidden', function( event ) {
667
+ // event.fragment = the fragment DOM element
668
+ } );
669
+ ```
670
+
671
+ ### Code syntax highlighting
672
+
673
+ By default, Reveal is configured with [highlight.js](https://highlightjs.org/) for code syntax highlighting. Below is an example with clojure code that will be syntax highlighted. When the `data-trim` attribute is present, surrounding whitespace is automatically removed. HTML will be escaped by default. To avoid this, for example if you are using `<mark>` to call out a line of code, add the `data-noescape` attribute to the `<code>` element.
674
+
675
+ ```html
676
+ <section>
677
+ <pre><code data-trim data-noescape>
678
+ (def lazy-fib
679
+ (concat
680
+ [0 1]
681
+ <mark>((fn rfib [a b]</mark>
682
+ (lazy-cons (+ a b) (rfib b (+ a b)))) 0 1)))
683
+ </code></pre>
684
+ </section>
685
+ ```
686
+
687
+ ### Slide number
688
+ If you would like to display the page number of the current slide you can do so using the ```slideNumber``` configuration value.
689
+
690
+ ```javascript
691
+ // Shows the slide number using default formatting
692
+ Reveal.configure({ slideNumber: true });
693
+
694
+ // Slide number formatting can be configured using these variables:
695
+ // "h.v": horizontal . vertical slide number (default)
696
+ // "h/v": horizontal / vertical slide number
697
+ // "c": flattened slide number
698
+ // "c/t": flattened slide number / total slides
699
+ Reveal.configure({ slideNumber: 'c/t' });
700
+
701
+ ```
702
+
703
+
704
+ ### Overview mode
705
+
706
+ Press "Esc" or "o" keys to toggle the overview mode on and off. While you're in this mode, you can still navigate between slides,
707
+ as if you were at 1,000 feet above your presentation. The overview mode comes with a few API hooks:
708
+
709
+ ```javascript
710
+ Reveal.addEventListener( 'overviewshown', function( event ) { /* ... */ } );
711
+ Reveal.addEventListener( 'overviewhidden', function( event ) { /* ... */ } );
712
+
713
+ // Toggle the overview mode programmatically
714
+ Reveal.toggleOverview();
715
+ ```
716
+
717
+ ### Fullscreen mode
718
+ Just press »F« on your keyboard to show your presentation in fullscreen mode. Press the »ESC« key to exit fullscreen mode.
719
+
720
+
721
+ ### Embedded media
722
+ Embedded HTML5 `<video>`/`<audio>` and YouTube iframes are automatically paused when you navigate away from a slide. This can be disabled by decorating your element with a `data-ignore` attribute.
723
+
724
+ Add `data-autoplay` to your media element if you want it to automatically start playing when the slide is shown:
725
+
726
+ ```html
727
+ <video data-autoplay src="http://clips.vorwaerts-gmbh.de/big_buck_bunny.mp4"></video>
728
+ ```
729
+
730
+ Additionally the framework automatically pushes two [post messages](https://developer.mozilla.org/en-US/docs/Web/API/Window.postMessage) to all iframes, ```slide:start``` when the slide containing the iframe is made visible and ```slide:stop``` when it is hidden.
731
+
732
+
733
+ ### Stretching elements
734
+ Sometimes it's desirable to have an element, like an image or video, stretch to consume as much space as possible within a given slide. This can be done by adding the ```.stretch``` class to an element as seen below:
735
+
736
+ ```html
737
+ <section>
738
+ <h2>This video will use up the remaining space on the slide</h2>
739
+ <video class="stretch" src="http://clips.vorwaerts-gmbh.de/big_buck_bunny.mp4"></video>
740
+ </section>
741
+ ```
742
+
743
+ Limitations:
744
+ - Only direct descendants of a slide section can be stretched
745
+ - Only one descendant per slide section can be stretched
746
+
747
+
748
+ ### postMessage API
749
+ The framework has a built-in postMessage API that can be used when communicating with a presentation inside of another window. Here's an example showing how you'd make a reveal.js instance in the given window proceed to slide 2:
750
+
751
+ ```javascript
752
+ <window>.postMessage( JSON.stringify({ method: 'slide', args: [ 2 ] }), '*' );
753
+ ```
754
+
755
+ When reveal.js runs inside of an iframe it can optionally bubble all of its events to the parent. Bubbled events are stringified JSON with three fields: namespace, eventName and state. Here's how you subscribe to them from the parent window:
756
+
757
+ ```javascript
758
+ window.addEventListener( 'message', function( event ) {
759
+ var data = JSON.parse( event.data );
760
+ if( data.namespace === 'reveal' && data.eventName ==='slidechanged' ) {
761
+ // Slide changed, see data.state for slide number
762
+ }
763
+ } );
764
+ ```
765
+
766
+ This cross-window messaging can be toggled on or off using configuration flags.
767
+
768
+ ```javascript
769
+ Reveal.initialize({
770
+ ...,
771
+
772
+ // Exposes the reveal.js API through window.postMessage
773
+ postMessage: true,
774
+
775
+ // Dispatches all reveal.js events to the parent window through postMessage
776
+ postMessageEvents: false
777
+ });
778
+ ```
779
+
780
+
781
+ ## PDF Export
782
+
783
+ Presentations can be exported to PDF via a special print stylesheet. This feature requires that you use [Google Chrome](http://google.com/chrome) or [Chromium](https://www.chromium.org/Home).
784
+ Here's an example of an exported presentation that's been uploaded to SlideShare: http://www.slideshare.net/hakimel/revealjs-300.
785
+
786
+ 1. Open your presentation with `print-pdf` included anywhere in the query string. This triggers the default index HTML to load the PDF print stylesheet ([css/print/pdf.css](https://github.com/hakimel/reveal.js/blob/master/css/print/pdf.css)). You can test this with [lab.hakim.se/reveal-js?print-pdf](http://lab.hakim.se/reveal-js?print-pdf).
787
+ 2. Open the in-browser print dialog (CTRL/CMD+P).
788
+ 3. Change the **Destination** setting to **Save as PDF**.
789
+ 4. Change the **Layout** to **Landscape**.
790
+ 5. Change the **Margins** to **None**.
791
+ 6. Enable the **Background graphics** option.
792
+ 7. Click **Save**.
793
+
794
+ ![Chrome Print Settings](https://s3.amazonaws.com/hakim-static/reveal-js/pdf-print-settings-2.png)
795
+
796
+ Alternatively you can use the [decktape](https://github.com/astefanutti/decktape) project.
797
+
798
+ ## Theming
799
+
800
+ The framework comes with a few different themes included:
801
+
802
+ - black: Black background, white text, blue links (default theme)
803
+ - white: White background, black text, blue links
804
+ - league: Gray background, white text, blue links (default theme for reveal.js < 3.0.0)
805
+ - beige: Beige background, dark text, brown links
806
+ - sky: Blue background, thin dark text, blue links
807
+ - night: Black background, thick white text, orange links
808
+ - serif: Cappuccino background, gray text, brown links
809
+ - simple: White background, black text, blue links
810
+ - solarized: Cream-colored background, dark green text, blue links
811
+
812
+ Each theme is available as a separate stylesheet. To change theme you will need to replace **black** below with your desired theme name in index.html:
813
+
814
+ ```html
815
+ <link rel="stylesheet" href="css/theme/black.css" id="theme">
816
+ ```
817
+
818
+ If you want to add a theme of your own see the instructions here: [/css/theme/README.md](https://github.com/hakimel/reveal.js/blob/master/css/theme/README.md).
819
+
820
+
821
+ ## Speaker Notes
822
+
823
+ reveal.js comes with a speaker notes plugin which can be used to present per-slide notes in a separate browser window. The notes window also gives you a preview of the next upcoming slide so it may be helpful even if you haven't written any notes. Press the 's' key on your keyboard to open the notes window.
824
+
825
+ 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.
826
+
827
+ Alternatively you can add your notes in a `data-notes` attribute on the slide. Like `<section data-notes="Something important"></section>`.
828
+
829
+ When used locally, this feature requires that reveal.js [runs from a local web server](#full-setup).
830
+
831
+ ```html
832
+ <section>
833
+ <h2>Some Slide</h2>
834
+
835
+ <aside class="notes">
836
+ 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).
837
+ </aside>
838
+ </section>
839
+ ```
840
+
841
+ If you're using the external Markdown plugin, you can add notes with the help of a special delimiter:
842
+
843
+ ```html
844
+ <section data-markdown="example.md" data-separator="^\n\n\n" data-separator-vertical="^\n\n" data-separator-notes="^Note:"></section>
845
+
846
+ # Title
847
+ ## Sub-title
848
+
849
+ Here is some content...
850
+
851
+ Note:
852
+ This will only display in the notes window.
853
+ ```
854
+
855
+ #### Share and Print Speaker Notes
856
+
857
+ Notes are only visible to the speaker inside of the speaker view. If you wish to share your notes with others you can initialize reveal.js with the `showNotes` config value set to `true`. Notes will appear along the bottom of the presentations.
858
+
859
+ When `showNotes` is enabled notes are also included when you [export to PDF](https://github.com/hakimel/reveal.js#pdf-export).
860
+
861
+ ## Server Side Speaker Notes
862
+
863
+ In some cases it can be desirable to run notes on a separate device from the one you're presenting on. The Node.js-based notes plugin lets you do this using the same note definitions as its client side counterpart. Include the required scripts by adding the following dependencies:
864
+
865
+ ```javascript
866
+ Reveal.initialize({
867
+ ...
868
+
869
+ dependencies: [
870
+ { src: 'socket.io/socket.io.js', async: true },
871
+ { src: 'plugin/notes-server/client.js', async: true }
872
+ ]
873
+ });
874
+ ```
875
+
876
+ Then:
877
+
878
+ 1. Install [Node.js](http://nodejs.org/) (1.0.0 or later)
879
+ 2. Run ```npm install```
880
+ 3. Run ```node plugin/notes-server```
881
+
882
+
883
+ ## Multiplexing
884
+
885
+ The multiplex plugin allows your audience to view the slides of the presentation you are controlling on their own phone, tablet or laptop. As the master presentation navigates the slides, all client presentations will update in real time. See a demo at [https://reveal-js-multiplex-ccjbegmaii.now.sh/](https://reveal-js-multiplex-ccjbegmaii.now.sh/).
886
+
887
+ The multiplex plugin needs the following 3 things to operate:
888
+
889
+ 1. Master presentation that has control
890
+ 2. Client presentations that follow the master
891
+ 3. Socket.io server to broadcast events from the master to the clients
892
+
893
+ More details:
894
+
895
+ #### Master presentation
896
+ Served from a static file server accessible (preferably) only to the presenter. This need only be on your (the presenter's) computer. (It's safer to run the master presentation from your own computer, so if the venue's Internet goes down it doesn't stop the show.) An example would be to execute the following commands in the directory of your master presentation:
897
+
898
+ 1. ```npm install node-static```
899
+ 2. ```static```
900
+
901
+ If you want to use the speaker notes plugin with your master presentation then make sure you have the speaker notes plugin configured correctly along with the configuration shown below, then execute ```node plugin/notes-server``` in the directory of your master presentation. The configuration below will cause it to connect to the socket.io server as a master, as well as launch your speaker-notes/static-file server.
902
+
903
+ You can then access your master presentation at ```http://localhost:1947```
904
+
905
+ Example configuration:
906
+ ```javascript
907
+ Reveal.initialize({
908
+ // other options...
909
+
910
+ multiplex: {
911
+ // Example values. To generate your own, see the socket.io server instructions.
912
+ secret: '13652805320794272084', // Obtained from the socket.io server. Gives this (the master) control of the presentation
913
+ id: '1ea875674b17ca76', // Obtained from socket.io server
914
+ url: 'https://reveal-js-multiplex-ccjbegmaii.now.sh' // Location of socket.io server
915
+ },
916
+
917
+ // Don't forget to add the dependencies
918
+ dependencies: [
919
+ { src: '//cdn.socket.io/socket.io-1.3.5.js', async: true },
920
+ { src: 'plugin/multiplex/master.js', async: true },
921
+
922
+ // and if you want speaker notes
923
+ { src: 'plugin/notes-server/client.js', async: true }
924
+
925
+ // other dependencies...
926
+ ]
927
+ });
928
+ ```
929
+
930
+ #### Client presentation
931
+ Served from a publicly accessible static file server. Examples include: GitHub Pages, Amazon S3, Dreamhost, Akamai, etc. The more reliable, the better. Your audience can then access the client presentation via ```http://example.com/path/to/presentation/client/index.html```, with the configuration below causing them to connect to the socket.io server as clients.
932
+
933
+ Example configuration:
934
+ ```javascript
935
+ Reveal.initialize({
936
+ // other options...
937
+
938
+ multiplex: {
939
+ // Example values. To generate your own, see the socket.io server instructions.
940
+ secret: null, // null so the clients do not have control of the master presentation
941
+ id: '1ea875674b17ca76', // id, obtained from socket.io server
942
+ url: 'https://reveal-js-multiplex-ccjbegmaii.now.sh' // Location of socket.io server
943
+ },
944
+
945
+ // Don't forget to add the dependencies
946
+ dependencies: [
947
+ { src: '//cdn.socket.io/socket.io-1.3.5.js', async: true },
948
+ { src: 'plugin/multiplex/client.js', async: true }
949
+
950
+ // other dependencies...
951
+ ]
952
+ });
953
+ ```
954
+
955
+ #### Socket.io server
956
+ Server that receives the slideChanged events from the master presentation and broadcasts them out to the connected client presentations. This needs to be publicly accessible. You can run your own socket.io server with the commands:
957
+
958
+ 1. ```npm install```
959
+ 2. ```node plugin/multiplex```
960
+
961
+ Or you use the socket.io server at [https://reveal-js-multiplex-ccjbegmaii.now.sh/](https://reveal-js-multiplex-ccjbegmaii.now.sh/).
962
+
963
+ You'll need to generate a unique secret and token pair for your master and client presentations. To do so, visit ```http://example.com/token```, where ```http://example.com``` is the location of your socket.io server. Or if you're going to use the socket.io server at [https://reveal-js-multiplex-ccjbegmaii.now.sh/](https://reveal-js-multiplex-ccjbegmaii.now.sh/), visit [https://reveal-js-multiplex-ccjbegmaii.now.sh/token](https://reveal-js-multiplex-ccjbegmaii.now.sh/token).
964
+
965
+ You are very welcome to point your presentations at the Socket.io server running at [https://reveal-js-multiplex-ccjbegmaii.now.sh/](https://reveal-js-multiplex-ccjbegmaii.now.sh/), but availability and stability are not guaranteed. For anything mission critical I recommend you run your own server. It is simple to deploy to nodejitsu, heroku, your own environment, etc.
966
+
967
+ ##### socket.io server as file static server
968
+
969
+ The socket.io server can play the role of static file server for your client presentation, as in the example at [https://reveal-js-multiplex-ccjbegmaii.now.sh/](https://reveal-js-multiplex-ccjbegmaii.now.sh/). (Open [https://reveal-js-multiplex-ccjbegmaii.now.sh/](https://reveal-js-multiplex-ccjbegmaii.now.sh/) in two browsers. Navigate through the slides on one, and the other will update to match.)
970
+
971
+ Example configuration:
972
+ ```javascript
973
+ Reveal.initialize({
974
+ // other options...
975
+
976
+ multiplex: {
977
+ // Example values. To generate your own, see the socket.io server instructions.
978
+ secret: null, // null so the clients do not have control of the master presentation
979
+ id: '1ea875674b17ca76', // id, obtained from socket.io server
980
+ url: 'example.com:80' // Location of your socket.io server
981
+ },
982
+
983
+ // Don't forget to add the dependencies
984
+ dependencies: [
985
+ { src: '//cdn.socket.io/socket.io-1.3.5.js', async: true },
986
+ { src: 'plugin/multiplex/client.js', async: true }
987
+
988
+ // other dependencies...
989
+ ]
990
+ ```
991
+
992
+ It can also play the role of static file server for your master presentation and client presentations at the same time (as long as you don't want to use speaker notes). (Open [https://reveal-js-multiplex-ccjbegmaii.now.sh/](https://reveal-js-multiplex-ccjbegmaii.now.sh/) in two browsers. Navigate through the slides on one, and the other will update to match. Navigate through the slides on the second, and the first will update to match.) This is probably not desirable, because you don't want your audience to mess with your slides while you're presenting. ;)
993
+
994
+ Example configuration:
995
+ ```javascript
996
+ Reveal.initialize({
997
+ // other options...
998
+
999
+ multiplex: {
1000
+ // Example values. To generate your own, see the socket.io server instructions.
1001
+ secret: '13652805320794272084', // Obtained from the socket.io server. Gives this (the master) control of the presentation
1002
+ id: '1ea875674b17ca76', // Obtained from socket.io server
1003
+ url: 'example.com:80' // Location of your socket.io server
1004
+ },
1005
+
1006
+ // Don't forget to add the dependencies
1007
+ dependencies: [
1008
+ { src: '//cdn.socket.io/socket.io-1.3.5.js', async: true },
1009
+ { src: 'plugin/multiplex/master.js', async: true },
1010
+ { src: 'plugin/multiplex/client.js', async: true }
1011
+
1012
+ // other dependencies...
1013
+ ]
1014
+ });
1015
+ ```
1016
+
1017
+ ## MathJax
1018
+
1019
+ If you want to display math equations in your presentation you can easily do so by including this plugin. The plugin is a very thin wrapper around the [MathJax](http://www.mathjax.org/) library. To use it you'll need to include it as a reveal.js dependency, [find our more about dependencies here](#dependencies).
1020
+
1021
+ The plugin defaults to using [LaTeX](http://en.wikipedia.org/wiki/LaTeX) but that can be adjusted through the ```math``` configuration object. Note that MathJax is loaded from a remote server. If you want to use it offline you'll need to download a copy of the library and adjust the ```mathjax``` configuration value.
1022
+
1023
+ Below is an example of how the plugin can be configured. If you don't intend to change these values you do not need to include the ```math``` config object at all.
1024
+
1025
+ ```js
1026
+ Reveal.initialize({
1027
+
1028
+ // other options ...
1029
+
1030
+ math: {
1031
+ mathjax: 'https://cdn.mathjax.org/mathjax/latest/MathJax.js',
1032
+ config: 'TeX-AMS_HTML-full' // See http://docs.mathjax.org/en/latest/config-files.html
1033
+ },
1034
+
1035
+ dependencies: [
1036
+ { src: 'plugin/math/math.js', async: true }
1037
+ ]
1038
+
1039
+ });
1040
+ ```
1041
+
1042
+ Read MathJax's documentation if you need [HTTPS delivery](http://docs.mathjax.org/en/latest/start.html#secure-access-to-the-cdn) or serving of [specific versions](http://docs.mathjax.org/en/latest/configuration.html#loading-mathjax-from-the-cdn) for stability.
1043
+
1044
+
1045
+ ## Installation
1046
+
1047
+ The **basic setup** is for authoring presentations only. The **full setup** gives you access to all reveal.js features and plugins such as speaker notes as well as the development tasks needed to make changes to the source.
1048
+
1049
+ ### Basic setup
1050
+
1051
+ The core of reveal.js is very easy to install. You'll simply need to download a copy of this repository and open the index.html file directly in your browser.
1052
+
1053
+ 1. Download the latest version of reveal.js from <https://github.com/hakimel/reveal.js/releases>
1054
+
1055
+ 2. Unzip and replace the example contents in index.html with your own
1056
+
1057
+ 3. Open index.html in a browser to view it
1058
+
1059
+
1060
+ ### Full setup
1061
+
1062
+ 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.
1063
+
1064
+ 1. Install [Node.js](http://nodejs.org/) (1.0.0 or later)
1065
+
1066
+ 2. Install [Grunt](http://gruntjs.com/getting-started#installing-the-cli)
1067
+
1068
+ 4. Clone the reveal.js repository
1069
+ ```sh
1070
+ $ git clone https://github.com/hakimel/reveal.js.git
1071
+ ```
1072
+
1073
+ 5. Navigate to the reveal.js folder
1074
+ ```sh
1075
+ $ cd reveal.js
1076
+ ```
1077
+
1078
+ 6. Install dependencies
1079
+ ```sh
1080
+ $ npm install
1081
+ ```
1082
+
1083
+ 7. Serve the presentation and monitor source files for changes
1084
+ ```sh
1085
+ $ grunt serve
1086
+ ```
1087
+
1088
+ 8. Open <http://localhost:8000> to view your presentation
1089
+
1090
+ You can change the port by using `grunt serve --port 8001`.
1091
+
1092
+
1093
+ ### Folder Structure
1094
+ - **css/** Core styles without which the project does not function
1095
+ - **js/** Like above but for JavaScript
1096
+ - **plugin/** Components that have been developed as extensions to reveal.js
1097
+ - **lib/** All other third party assets (JavaScript, CSS, fonts)
1098
+
1099
+
1100
+ ## License
1101
+
1102
+ MIT licensed
1103
+
1104
+ Copyright (C) 2016 Hakim El Hattab, http://hakim.se