You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Please keep the [issue tracker](http://github.com/hakimel/reveal.js/issues) limited to **bug reports**, **feature requests** and **pull requests**.
4
+
5
+
6
+
### Personal Support
7
+
If you have personal support or setup questions the best place to ask those are [StackOverflow](http://stackoverflow.com/questions/tagged/reveal.js).
8
+
9
+
10
+
### Bug Reports
11
+
When reporting a bug make sure to include information about which browser and operating system you are on as well as the necessary steps to reproduce the issue. If possible please include a link to a sample presentation where the bug can be tested.
12
+
13
+
14
+
### Pull Requests
15
+
- Should follow the coding style of the file you work in, most importantly:
16
+
- Tabs to indent
17
+
- Single-quoted strings
18
+
- Should be made towards the **dev branch**
19
+
- Should be submitted from a feature/topic branch (not your master)
20
+
- Should not include the minified **reveal.min.js** or **reveal.min.css** files
Copy file name to clipboardexpand all lines: README.md
+44-35
Original file line number
Diff line number
Diff line change
@@ -13,7 +13,7 @@ reveal.js comes with a broad range of features including [nested slides](https:/
13
13
14
14
## Online Editor
15
15
16
-
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://slid.es](http://slid.es).
16
+
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).
17
17
18
18
19
19
## Instructions
@@ -59,8 +59,8 @@ When used locally, this feature requires that reveal.js [runs from a local web s
59
59
```html
60
60
<sectiondata-markdown="example.md"
61
61
data-separator="^\n\n\n"
62
-
data-vertical="^\n\n"
63
-
data-notes="^Note:"
62
+
data-separator-vertical="^\n\n"
63
+
data-separator-notes="^Note:"
64
64
data-charset="iso-8859-15">
65
65
</section>
66
66
```
@@ -136,6 +136,10 @@ Reveal.initialize({
136
136
// i.e. contained within a limited portion of the screen
137
137
embedded:false,
138
138
139
+
// Flags if we should show a help overlay when the questionmark
140
+
// key is pressed
141
+
help:true,
142
+
139
143
// Number of milliseconds between automatically proceeding to the
140
144
// next slide, disabled when set to 0, this value can be overwritten
141
145
// by using a data-autoslide attribute on your slides
// Number of slides away from the current that are visible
166
170
viewDistance:3,
@@ -175,8 +179,6 @@ Reveal.initialize({
175
179
});
176
180
```
177
181
178
-
Note that the new default vertical centering option will break compatibility with slides that were using transitions with backgrounds (`cube` and `page`). To restore the previous behavior, set `center` to `false`.
179
-
180
182
181
183
The configuration can be updated after initialization using the ```configure``` method:
182
184
@@ -266,15 +268,20 @@ Reveal.configure({
266
268
autoSlide:5000
267
269
});
268
270
```
271
+
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.
269
272
270
-
When this is turned on a control element will appear that enables users to pause and resume auto-sliding. Sliding is also paused automatically as soon as the user starts navigating. You can disable these controls by specifying ```autoSlideStoppable: false``` in your reveal.js config.
271
-
272
-
You can also override the slide duration for individual slides by using the ```data-autoslide``` attribute on individual sections:
273
+
You can also override the slide duration for individual slides and fragments by using the ```data-autoslide``` attribute:
273
274
274
275
```html
275
-
<sectiondata-autoslide="10000">This will remain on screen for 10 seconds</section>
276
+
<sectiondata-autoslide="2000">
277
+
<p>After 2 seconds the first fragment will be shown.</p>
278
+
<pclass="fragment"data-autoslide="10000">After 10 seconds the next fragment will be shown.</p>
279
+
<pclass="fragment">Now, the fragment is displayed for 2 seconds before the next slide is shown.</p>
280
+
</section>
276
281
```
277
282
283
+
Whenever the auto-slide mode is resumed or paused the ```autoslideresumed``` and ```autoslidepaused``` events are fired.
284
+
278
285
279
286
### Keyboard Bindings
280
287
@@ -290,6 +297,23 @@ Reveal.configure({
290
297
});
291
298
```
292
299
300
+
### Lazy Loading
301
+
302
+
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.
303
+
304
+
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.
305
+
306
+
```html
307
+
<section>
308
+
<imgdata-src="image.png">
309
+
<iframedata-src="http://slides.com">
310
+
<video>
311
+
<sourcedata-src="video.webm"type="video/webm" />
312
+
<sourcedata-src="video.mp4"type="video/mp4" />
313
+
</video>
314
+
</section>
315
+
```
316
+
293
317
294
318
### API
295
319
@@ -308,6 +332,7 @@ Reveal.prevFragment();
308
332
Reveal.nextFragment();
309
333
Reveal.toggleOverview();
310
334
Reveal.togglePause();
335
+
Reveal.toggleAutoSlide();
311
336
312
337
// Retrieves the previous and current slide elements
313
338
Reveal.getPreviousSlide();
@@ -320,6 +345,7 @@ Reveal.isFirstSlide();
320
345
Reveal.isLastSlide();
321
346
Reveal.isOverview();
322
347
Reveal.isPaused();
348
+
Reveal.isAutoSliding();
323
349
```
324
350
325
351
### Ready Event
@@ -390,7 +416,7 @@ Reveal.initialize({
390
416
parallaxBackgroundSize:'', // CSS syntax, e.g. "2100px 900px" - currently only pixels are supported (don't use % or auto)
391
417
392
418
// This slide transition gives best results:
393
-
transition:linear
419
+
transition:'slide'
394
420
395
421
});
396
422
```
@@ -563,7 +589,7 @@ Limitations:
563
589
Presentations can be exported to PDF via a special print stylesheet. This feature requires that you use [Google Chrome](http://google.com/chrome).
564
590
Here's an example of an exported presentation that's been uploaded to SlideShare: http://www.slideshare.net/hakimel/revealjs-13872948.
565
591
566
-
1. Open your presentation with [css/print/pdf.css](https://github.com/hakimel/reveal.js/blob/master/css/print/pdf.css) included on the page. The default index HTML lets you add *print-pdf* anywhere in the query to include the stylesheet, for example:[lab.hakim.se/reveal-js?print-pdf](http://lab.hakim.se/reveal-js?print-pdf).
592
+
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).
567
593
2. Open the in-browser print dialog (CMD+P).
568
594
3. Change the **Destination** setting to **Save as PDF**.
569
595
4. Change the **Layout** to **Landscape**.
@@ -614,7 +640,7 @@ When used locally, this feature requires that reveal.js [runs from a local web s
614
640
If you're using the external Markdown plugin, you can add notes with the help of a special delimiter:
@@ -909,23 +935,6 @@ Some reveal.js features, like external markdown and speaker notes, require that
909
935
- **lib/** All other third party assets (JavaScript, CSS, fonts)
910
936
911
937
912
-
### Contributing
913
-
914
-
Please keep the [issue tracker](http://github.com/hakimel/reveal.js/issues) limited to **bug reports**, **feature requests** and **pull requests**. If you are reporting a bug make sure to include information about which browser and operating system you are using as well as the necessary steps to reproduce the issue.
915
-
916
-
If you have personal support questions use [StackOverflow](http://stackoverflow.com/questions/tagged/reveal.js).
917
-
918
-
919
-
#### Pull requests
920
-
921
-
- Should follow the coding style of the file you work in, most importantly:
922
-
- Tabs to indent
923
-
- Single-quoted strings
924
-
- Should be made towards the **dev branch**
925
-
- Should be submitted from a feature/topic branch (not your master)
926
-
- Should not include the minified **reveal.min.js** file
0 commit comments